{
  "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" : 1,
    "x-generated-on" : 1790227826661
  },
  "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" : "addons",
    "description" : "Addons are additional charges applied to a subscription apart from the base plan charge."
  }, {
    "name" : "addresses",
    "description" : "Subscriptions can have addresses like \"Shipping Address\" associated with them."
  }, {
    "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/1.0/credit-notes.html) is a document that specifies the money owed by a business to its customer."
  }, {
    "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" : "disputes",
    "description" : "Operations on the `disputes` resource."
  }, {
    "name" : "einvoices",
    "description" : "An e-invoice record associated with an invoice or credit note."
  }, {
    "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 Whenever any important changes happen in 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" : "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" : "Operations on the `grant_blocks` resource."
  }, {
    "name" : "hosted_pages",
    "description" : "Hosted pages are the easiest and most secure way to integrate chargebee with your website."
  }, {
    "name" : "in_app_subscriptions",
    "description" : "**Important:** These APIs operate asynchronously."
  }, {
    "name" : "invoices",
    "description" : "Invoices are statements containing charges, adjustments and any discounts for a subscription specific to a term."
  }, {
    "name" : "non_subscriptions",
    "description" : "**Important:** These APIs operate asynchronously."
  }, {
    "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" : "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_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" : "plans",
    "description" : "Specifies the price with billing frequency for a subscription."
  }, {
    "name" : "portal_sessions",
    "description" : "Customer Portal lets your customers to manage their account and billing themselves."
  }, {
    "name" : "promotional_credits",
    "description" : "These credits can be provided to the customer for promoting the product."
  }, {
    "name" : "quotes",
    "description" : "A quote is an estimate of the invoice with the charges likely to occur when customers buy an item."
  }, {
    "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" : "Subscription represents the recurring items a customer has subscribed to."
  }, {
    "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 holds 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" : "vaulted_payment_methods",
    "description" : "Operations on the `vaulted_payment_methods` resource."
  }, {
    "name" : "virtual_bank_accounts",
    "description" : "A virtual bank account is a unique account number which is generated so you don't need to share your sensitive bank account details with your users."
  }, {
    "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 schedules",
        "description" : "Deletes an advance invoicing schedule. When *schedule_type = specific_dates*, you also have the option of deleting a part of the schedule.\n",
        "operationId" : "remove_an_advance_invoice_schedules",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "subscription-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/subscription-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "specific_dates_schedule" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for specific_dates_schedule\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "When *schedule_type = specific_dates*\n, pass the id of the [specific_dates_schedule](/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#specific_dates_schedule)\nthat you want to remove. If not passed, the entire advance_invoice_schedule is removed.\n",
                        "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\n"
                    },
                    "advance_invoice_schedules" : {
                      "type" : "array",
                      "description" : "Resource object representing advance_invoice_schedule\n",
                      "items" : {
                        "$ref" : "#/components/schemas/AdvanceInvoiceSchedule",
                        "description" : "Resource object representing advance_invoice_schedule"
                      },
                      "example" : null
                    }
                  },
                  "required" : [ "subscription" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/subscriptions/{subscription-id}/remove_coupons" : {
      "post" : {
        "tags" : [ "subscriptions" ],
        "summary" : "Remove coupons",
        "description" : "Removes Coupons associated with the Subscription. If the param 'coupon_ids' is not specified, all the Coupons linked to the Subscription will be removed.\n",
        "operationId" : "remove_coupons",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "subscription-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/subscription-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "coupon_ids" : {
                    "type" : "array",
                    "deprecated" : false,
                    "description" : "List of coupons to be removed from the subscription. You can provide only [coupon_id](/docs/api/coupons/coupon-object#id)\nand not [coupon_code](/docs/api/coupon_codes/coupon_code-object#code)\n.\n",
                    "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\n"
                    },
                    "customer" : {
                      "$ref" : "#/components/schemas/Customer",
                      "description" : "Resource object representing customer\n"
                    },
                    "card" : {
                      "$ref" : "#/components/schemas/Card",
                      "description" : "Resource object representing card\n"
                    }
                  },
                  "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:**\nThis operation optionally supports 3DS verification flow. To achieve the same, create the [Payment Intent](/docs/api/getting-started)\nand pass it as input parameter to this API.\n\nThis API is used to resume a **paused** subscription. On resumption the subscription will be activated and any applicable charges will be initiated.\n\nYou 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.\n\nFor in-term resumption, unless there are scheduled changes, unbilled charges will not be charged.\n\n**What is an \"in-term resumption\"?**\n\nAn \"in-term resumption\" is when the pause and resumption happens within the billing term of the subscription.\n\n**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.\n\n#### UNPAID INVOICES\n\nSpecifying **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.\n\nIf specified as **schedule_payment_collection**, payment collection for the amount due of past invoices will be attempted. The payment method available will be charged if auto-collection is enabled for the customer, and appropriate payment collection(payment succeeded or payment failed) events will be triggered. If the payment collection fails, no further retries will be made on the invoices.\n\n**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.\n",
        "operationId" : "resume_a_subscription",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "subscription-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/subscription-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "resume_option" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "List of options to resume the subscription.\n\n* immediately - Resume immediately\n* specific_date - Resume on a specific date\n",
                    "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**\nis set as 'specific_date'.\n",
                    "example" : null
                  },
                  "charges_handling" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Applicable when charges get added during this operation and **resume_option**\nis set as 'immediately'. Allows to raise invoice immediately or add them to unbilled charges.\n\n* add_to_unbilled_charges - Add to unbilled charges\n* invoice_immediately - Invoice immediately\n",
                    "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**\nis 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.\n**Note:**\nThe payment collection attempt will be asynchronous.\n\n* no_action - Retain as unpaid\n* schedule_payment_collection - Collect payment\n",
                    "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.\n\n* customer - Pass this value to indicate that the request is initiated by the customer\n* merchant - Pass this value to indicate that the request is initiated by the merchant\n",
                    "enum" : [ "customer", "merchant" ],
                    "example" : null
                  },
                  "payment_intent" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for payment_intent\n",
                    "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.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "gateway_account_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The gateway account used for performing the 3DS flow.\n",
                        "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)\nto find out the gateway-specific gw_token format. Applicable when you are using gateway APIs directly for completing the 3DS flow.\n",
                        "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.\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.\n",
                        "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).\n\n  * `payer`: User related information.\n    * `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).\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n    * `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.\n* `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.\n\n  * `fraud`: Fraud identification related information.\n    * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n* `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.\n\n  * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.\n* `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.\n\n  * `payer`: User related information.\n    * `document`: Document is the user's identification number based on their country.\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device\n",
                        "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\n"
                    },
                    "customer" : {
                      "$ref" : "#/components/schemas/Customer",
                      "description" : "Resource object representing customer\n"
                    },
                    "card" : {
                      "$ref" : "#/components/schemas/Card",
                      "description" : "Resource object representing card\n"
                    },
                    "invoice" : {
                      "$ref" : "#/components/schemas/Invoice",
                      "description" : "Resource object representing invoice\n"
                    },
                    "unbilled_charges" : {
                      "type" : "array",
                      "description" : "Resource object representing unbilled_charge\n",
                      "items" : {
                        "$ref" : "#/components/schemas/UnbilledCharge",
                        "description" : "Resource object representing unbilled_charge"
                      },
                      "example" : null
                    }
                  },
                  "required" : [ "customer", "subscription" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/subscriptions/{subscription-id}/regenerate_invoice" : {
      "post" : {
        "tags" : [ "subscriptions" ],
        "summary" : "Regenerate an invoice",
        "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:\n\n* An invoice exists for the current term and its `status` is not `voided`.\n* There are [unbilled charges](https://www.chargebee.com/docs/unbilled-charges.html) for the current term.\n* The subscription has an [advance invoice](https://www.chargebee.com/docs/advance-invoices.html).\n\n#### Response\n\nReturns one of the following depending on the value of `invoice_immediately`:\n\n* If the value is `true`: an `invoice` object that corresponds to the regenerated invoice.\n* If the value is `false`: a list of `unbilled_charge` objects corresponding to all the unbilled charges created for the current term of the subscription.\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" : "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)\n.\n",
                    "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)\n.\n",
                    "example" : null
                  },
                  "prorate" : {
                    "type" : "boolean",
                    "deprecated" : false,
                    "description" : "Whether the charges should be prorated according to the term specified by `date_from`\nand `date_to`.\nShould not be passed without `date_from`\nand `date_to`\n.\n",
                    "example" : null
                  },
                  "invoice_immediately" : {
                    "type" : "boolean",
                    "deprecated" : false,
                    "description" : "Only applicable when [Consolidated Invoicing](https://www.chargebee.com/docs/consolidated-invoicing.html )\nis enabled for the customer. Set to `false`\nto leave the current term charge for the subscription as [unbilled](https://www.chargebee.com/docs/unbilled-charges.html ).\nOnce 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)\nto invoice them.\n",
                    "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\n"
                    },
                    "unbilled_charges" : {
                      "type" : "array",
                      "description" : "Resource object representing unbilled_charge\n",
                      "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" : "**Important**\n\nFor sites where both [legacy and latest](/docs/api/v2/pcv-1/upgrade#retrieving-api-responses-in-latest-api-format) product catalog versions are active, GET API requests return responses in a `compat` format by default. This format works with both latest and legacy Product Catalog.\n\n**Override options:**\n\n* `chargebee-response-schema-type: items` → Return response in latest product catalog format only.\n* `chargebee-response-schema-type: plans_addons` → Return response in legacy product catalog format only.\n\nReturns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.\n",
        "operationId" : "list_subscriptions",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "limit",
          "in" : "query",
          "description" : "The number of resources to be returned.\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`\nto the value of `next_offset`\nobtained in the previous iteration of the API call.\n",
          "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`\nas `true`\n.\n",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "boolean",
            "default" : false,
            "example" : null
          }
        }, {
          "name" : "id",
          "in" : "query",
          "description" : "optional, string filter\n\nA unique and immutable identifier for the subscription. If not provided, it is autogenerated.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*id\\[is\\] = \"8gsnbYfsMLds\"*\n",
          "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\n\nIdentifier of the customer with whom this subscription is associated.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*customer_id\\[is\\] = \"8gsnbYfsMLds\"*\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "example" : "8gsnbYfsMLds",
            "properties" : {
              "is" : {
                "type" : "string",
                "minLength" : 1,
                "example" : null
              },
              "is_not" : {
                "type" : "string",
                "minLength" : 1,
                "example" : null
              },
              "starts_with" : {
                "type" : "string",
                "minLength" : 1,
                "example" : null
              },
              "in" : {
                "type" : "string",
                "pattern" : "^\\[(.*)(,.*)*\\]$",
                "example" : null
              },
              "not_in" : {
                "type" : "string",
                "pattern" : "^\\[(.*)(,.*)*\\]$",
                "example" : null
              }
            }
          }
        }, {
          "name" : "plan_id",
          "in" : "query",
          "description" : "optional, string filter\n\nIdentifier of the plan for this subscription.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*plan_id\\[is\\] = \"basic\"*\n",
          "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\n\nCurrent state of the subscription. Possible values are : future, in_trial, active, non_renewing, paused, cancelled.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*status\\[is\\] = \"active\"*\n",
          "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.\n* `in_trial` - The subscription is in trial.\n* `active` - The subscription is active and will be charged for automatically based on the items in it.\n* `non_renewing` - The subscription will be canceled at the end of the current term.\n* `paused` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state.\n* `cancelled` - The subscription has been canceled and is no longer in service.\n* `transferred` - The subscription has been transferred to another business entity within the organization.\n",
                "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.\n* `in_trial` - The subscription is in trial.\n* `active` - The subscription is active and will be charged for automatically based on the items in it.\n* `non_renewing` - The subscription will be canceled at the end of the current term.\n* `paused` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state.\n* `cancelled` - The subscription has been canceled and is no longer in service.\n* `transferred` - The subscription has been transferred to another business entity within the organization.\n",
                "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.\n* `in_trial` - The subscription is in trial.\n* `active` - The subscription is active and will be charged for automatically based on the items in it.\n* `non_renewing` - The subscription will be canceled at the end of the current term.\n* `paused` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state.\n* `cancelled` - The subscription has been canceled and is no longer in service.\n* `transferred` - The subscription has been transferred to another business entity within the organization.\n",
                "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.\n* `in_trial` - The subscription is in trial.\n* `active` - The subscription is active and will be charged for automatically based on the items in it.\n* `non_renewing` - The subscription will be canceled at the end of the current term.\n* `paused` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state.\n* `cancelled` - The subscription has been canceled and is no longer in service.\n* `transferred` - The subscription has been transferred to another business entity within the organization.\n",
                "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\n\nThe 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.\n\n**Supported operators :**\nis, is_not, in, not_in, is_present\n\n**Example →**\n*cancel_reason\\[is\\] = \"not_paid\"*\n",
          "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\n* `no_card` - No Card\n* `fraud_review_failed` - Fraud Review Failed\n* `non_compliant_eu_customer` - Non Compliant EU Customer\n* `tax_calculation_failed` - Tax Calculation Failed\n* `currency_incompatible_with_gateway` - Currency incompatible with Gateway\n* `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\n* `no_card` - No Card\n* `fraud_review_failed` - Fraud Review Failed\n* `non_compliant_eu_customer` - Non Compliant EU Customer\n* `tax_calculation_failed` - Tax Calculation Failed\n* `currency_incompatible_with_gateway` - Currency incompatible with Gateway\n* `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\n* `no_card` - No Card\n* `fraud_review_failed` - Fraud Review Failed\n* `non_compliant_eu_customer` - Non Compliant EU Customer\n* `tax_calculation_failed` - Tax Calculation Failed\n* `currency_incompatible_with_gateway` - Currency incompatible with Gateway\n* `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\n* `no_card` - No Card\n* `fraud_review_failed` - Fraud Review Failed\n* `non_compliant_eu_customer` - Non Compliant EU Customer\n* `tax_calculation_failed` - Tax Calculation Failed\n* `currency_incompatible_with_gateway` - Currency incompatible with Gateway\n* `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\n\nReason 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** .\nMust be passed if set as mandatory in the app. The codes are case-sensitive.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*cancel_reason_code\\[is_not\\] = \"Not Paid\"*\n",
          "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\n\n* 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.\n* 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\n\n**Example →**\n*remaining_billing_cycles\\[gt\\] = \"3\"*\n",
          "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\n\nThe time at which the subscription was created.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*created_at\\[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" : "activated_at",
          "in" : "query",
          "description" : "optional, timestamp(UTC) in seconds filter\n\nTime at which the subscription `status`\nlast changed to\n`active`.\nFor example, this value is updated when an `in_trial`\nor\n`cancelled`\nsubscription activates.\n**Supported operators :**\nafter, before, on, between, is_present\n\n**Example →**\n*activated_at\\[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
              },
              "is_present" : {
                "type" : "string",
                "format" : "boolean",
                "enum" : [ "true", "false" ],
                "example" : null
              }
            }
          }
        }, {
          "name" : "next_billing_at",
          "in" : "query",
          "description" : "optional, timestamp(UTC) in seconds filter\n\nThe date/time at which the next billing for the subscription happens. This is usually right after `current_term_end`\nunless multiple subscription terms were invoiced in advance using the `terms_to_charge`\nparameter.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*next_billing_at\\[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" : "cancelled_at",
          "in" : "query",
          "description" : "optional, timestamp(UTC) in seconds filter\n\nTime at which subscription was cancelled or is set to be cancelled.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*cancelled_at\\[on\\] = \"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" : "has_scheduled_changes",
          "in" : "query",
          "description" : "optional, boolean filter\n\nIf `true`\n, there are subscription changes scheduled on next renewal. Possible values are : *true, false*\n\n**Supported operators :**\nis\n\n**Example →**\n*has_scheduled_changes\\[is\\] = \"true\"*\n",
          "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\n\nTo filter based on `updated_at`.\nThis 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`\ninput parameter as `updated_at`\nfor a faster response.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*updated_at\\[after\\] = \"1243545465\"*\n",
          "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\n\nThe preferred offline payment method for the subscription. Possible values are : no_preference, cash, check, bank_transfer, ach_credit, sepa_credit.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*offline_payment_method\\[is\\] = \"cash\"*\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "example" : "cash",
            "properties" : {
              "is" : {
                "type" : "string",
                "description" : "* `no_preference` - No Preference\n* `cash` - Cash\n* `check` - Check\n* `bank_transfer` - Bank Transfer\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `boleto` - Boleto\n* `us_automated_bank_transfer` - US Automated Bank Transfer\n* `eu_automated_bank_transfer` - EU Automated Bank Transfer\n* `uk_automated_bank_transfer` - UK Automated Bank Transfer\n* `jp_automated_bank_transfer` - JP Automated Bank Transfer\n* `mx_automated_bank_transfer` - MX Automated Bank Transfer\n* `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\n* `cash` - Cash\n* `check` - Check\n* `bank_transfer` - Bank Transfer\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `boleto` - Boleto\n* `us_automated_bank_transfer` - US Automated Bank Transfer\n* `eu_automated_bank_transfer` - EU Automated Bank Transfer\n* `uk_automated_bank_transfer` - UK Automated Bank Transfer\n* `jp_automated_bank_transfer` - JP Automated Bank Transfer\n* `mx_automated_bank_transfer` - MX Automated Bank Transfer\n* `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\n* `cash` - Cash\n* `check` - Check\n* `bank_transfer` - Bank Transfer\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `boleto` - Boleto\n* `us_automated_bank_transfer` - US Automated Bank Transfer\n* `eu_automated_bank_transfer` - EU Automated Bank Transfer\n* `uk_automated_bank_transfer` - UK Automated Bank Transfer\n* `jp_automated_bank_transfer` - JP Automated Bank Transfer\n* `mx_automated_bank_transfer` - MX Automated Bank Transfer\n* `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\n* `cash` - Cash\n* `check` - Check\n* `bank_transfer` - Bank Transfer\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `boleto` - Boleto\n* `us_automated_bank_transfer` - US Automated Bank Transfer\n* `eu_automated_bank_transfer` - EU Automated Bank Transfer\n* `uk_automated_bank_transfer` - UK Automated Bank Transfer\n* `jp_automated_bank_transfer` - JP Automated Bank Transfer\n* `mx_automated_bank_transfer` - MX Automated Bank Transfer\n* `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\n\nSet to `false`\nto override for this subscription, the [site-level setting](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing)\nfor 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).\nPossible values are : *true, false*\n\n**Supported operators :**\nis\n\n**Example →**\n*auto_close_invoices\\[is\\] = \"true\"*\n",
          "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\n\nIf `true`\n, ignores the [hierarchy relationship](/docs/api/customers/customer-object#relationship)\nand uses customer as payment and invoice owner. Possible values are : *true, false*\n\n**Supported operators :**\nis\n\n**Example →**\n*override_relationship\\[is\\] = \"false\"*\n",
          "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\n\nSorts based on the specified attribute.\n**Supported attributes :**\ncreated_at, updated_at\n\n**Supported sort-orders :**\nasc, desc\n\n**Example →**\n*sort_by\\[asc\\] = \"created_at\"*\n\nThis will sort the result based on the 'created_at' attribute in ascending(earliest first) order.\n",
          "required" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "additionalProperties" : true,
            "properties" : {
              "asc" : {
                "type" : "string",
                "enum" : [ "created_at", "updated_at" ],
                "example" : null
              },
              "desc" : {
                "type" : "string",
                "enum" : [ "created_at", "updated_at" ],
                "example" : null
              }
            },
            "example" : null
          }
        }, {
          "name" : "business_entity_id",
          "in" : "query",
          "description" : "optional, string filter\n\nThe ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity.  \n**Note**\n\n[Multiple Business Entities](/docs/api/getting-started) is a feature available only on Product Catalog 2.0.\n\n**Supported operators :**\nis, is_not, starts_with\n\n**Example →**\n*business_entity_id\\[is\\] = \"business_entity_id\"*\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "example" : "business_entity_id",
            "properties" : {
              "is" : {
                "type" : "string",
                "minLength" : 1,
                "example" : null
              }
            }
          }
        }, {
          "name" : "channel",
          "in" : "query",
          "description" : "optional, enumerated string filter\n\nThe subscription channel this object originated from and is maintained in. Possible values are : web, app_store, play_store.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*channel\\[is_not\\] = \"APP STORE\"*\n",
          "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",
          "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`.\n",
                      "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" : "Create a subscription",
        "description" : "**Note:**\nThis operation optionally supports 3DS verification flow. To achieve the same, create the [Payment Intent](/docs/api/getting-started)\nand pass it as input parameter to this API.\n\nCreates a new subscription along with the customer. You can attach a plan, plan quantity, one or more addons and coupon while creating this subscription.\n\n#### Future Subscriptions\n\nIf the **start_date** is specified, the subscription will be created in 'future' state (.ie, instead of starting immediately it will be scheduled to start at the specified 'start_date'). Besides if 'trial' is specified (plan configuration or specified explicitly using trial_end), the subscription will go into 'trial' state when it starts. Otherwise it will directly become 'active' when it starts.\n\n#### Trial Period\n\nIf the plan has trial period or if the trial_end is specified explicitly, the subscription will be created in 'in_trial' state.\n\nIf the card details are passed, it is not charged until the end of the trial period. Incase you need to verify the card you could enable the ['card verification option'](https://www.chargebee.com/docs/cards.html#card-verification) in the gateway settings.\n\n#### Invoice\n\nIf the plan does not have a trial period and if any of the recurring items has charges, then a invoice would be raised immediately. If 'auto_collection' is turned 'on', then card attributes are mandatory and subscription will be created only if the payment was successful.\n\n#### Card details\n\nPassing card details to this API involves PCI liability at your end as sensitive card information passes through your servers. If you wish to avoid that, you can use one of the following integration methodologies if applicable\n\n* If you are using Stripe gateway, you can use [Stripe.js](https://stripe.com/docs/stripe.js) with your checkout form. Take a look at this [Stripe tutorial](https://stripe.com/docs/payments/accept-a-payment-charges) for more details.\n* If you are using Braintree gateway, you can use [Braintree.js](https://www.braintreepayments.com/docs/javascript) with your checkout form. Please refer this [tutorial](https://www.chargebee.com/tutorials/braintree-js-example.html) for more details.\n* If you are using Authorize.Net gateway, you use [Accept.js](https://developer.authorize.net/api/reference/features/acceptjs.html) with your checkout form.\n* 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.\n\n**Legacy behavior:**\n\n* **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.\n* **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.\n\n#### Related Tutorials\n\n* [Check out this tutorial to create trial signup with custom fields.](https://www.chargebee.com/tutorials/custom-fields-recurring-billing-example.html)\n* [Learn how to implement a in-app checkout flow that allows your customers to select addons and apply coupons. Estimate API is used to dynamically calculate the order summary shown to the customer.](https://www.chargebee.com/tutorials/in-app-checkout-page-using-estimate-api-example.html)\n",
        "operationId" : "create_a_subscription",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "additionalProperties" : true,
                "properties" : {
                  "id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "A unique and immutable identifier for the subscription. If not provided, it is autogenerated.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "brand_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "maxLength" : 50,
                    "example" : null
                  },
                  "plan_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Identifier of the plan for this subscription.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "plan_quantity" : {
                    "type" : "integer",
                    "format" : "int32",
                    "default" : 1,
                    "deprecated" : false,
                    "description" : "Plan quantity for this subscription.\n",
                    "minimum" : 1,
                    "example" : null
                  },
                  "plan_quantity_in_decimal" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                    "maxLength" : 33,
                    "example" : null
                  },
                  "plan_unit_price" : {
                    "type" : "integer",
                    "format" : "int64",
                    "deprecated" : false,
                    "description" : "Plan Unit Amount for create subscription.\n",
                    "minimum" : 0,
                    "example" : null
                  },
                  "plan_unit_price_in_decimal" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Plan Unit Amount in Decimal for create subscription.\n",
                    "maxLength" : 39,
                    "example" : null
                  },
                  "setup_fee" : {
                    "type" : "integer",
                    "format" : "int64",
                    "deprecated" : false,
                    "description" : "Amount that will override the default setup fee. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                    "minimum" : 0,
                    "example" : null
                  },
                  "trial_end" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "The time at which the trial ends for this subscription. Can be specified to override the default trial period.If **'0'**\nis passed, the subscription will be activated immediately.\n",
                    "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/v2/pcv-1/contract_terms) or not.\n\n* When the subscription is not on a contract term: if `billing_cycles` is not provided, then the billing cycles [set for the plan](/docs/api/v2/pcv-1/plans/plan-object#billing_cycles) is used. Moreover, once the `billing_cycles` have completed, the subscription cancels.\n* 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.\n",
                    "minimum" : 0,
                    "example" : null
                  },
                  "mandatory_addons_to_remove" : {
                    "type" : "array",
                    "deprecated" : false,
                    "description" : "List of addons IDs that are mandatory to the plan and has to be removed from the subscription.\n",
                    "items" : {
                      "type" : "string",
                      "deprecated" : false,
                      "maxLength" : 100,
                      "example" : null
                    },
                    "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:\n\n* Backdating is enabled for subscription creation operations.\n* 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.\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, `start_date` cannot be earlier than 14th February. .\n",
                    "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.\n\n* on - Whenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.\n* off - Automatic collection of charges will not be made for this subscription. Use this for offline payments.\n",
                    "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)\n.\n",
                    "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)\nfor Calendar Billing. Only applicable when using Calendar Billing. The default value is that which has been configured for the site.\n\n* immediate - Subscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..\n* delayed - Subscription period will be aligned with the configured billing date at the next renewal.\n",
                    "enum" : [ "immediate", "delayed" ],
                    "example" : null
                  },
                  "offline_payment_method" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The preferred offline payment method for the subscription.\n\n* cash - Cash\n* bank_transfer - Bank Transfer\n* check - Check\n* custom - Custom\n* us_automated_bank_transfer - US Automated Bank Transfer\n* ach_credit - ACH Credit\n* sepa_credit - SEPA Credit\n* no_preference - No Preference\n* eu_automated_bank_transfer - EU Automated Bank Transfer\n* jp_automated_bank_transfer - JP Automated Bank Transfer\n* uk_automated_bank_transfer - UK Automated Bank Transfer\n* boleto - Boleto\n* mx_automated_bank_transfer - MX Automated Bank Transfer\n",
                    "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.\n",
                    "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.\n",
                    "items" : {
                      "type" : "string",
                      "deprecated" : false,
                      "maxLength" : 100,
                      "example" : null
                    },
                    "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/1.0/payment-gateways-and-configuration/gateway_settings#smart-routing).\nExplicitly passing a `gateway_id`\nin this API call will not override the gateway associated with the token.\n",
                    "maxLength" : 40,
                    "example" : null
                  },
                  "affiliate_token" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "A unique tracking token.\n",
                    "maxLength" : 250,
                    "example" : null
                  },
                  "invoice_notes" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "A customer-facing note added to all invoices associated with this subscription. This note is one among [all the notes](/docs/api/invoices/invoice-object#notes)\ndisplayed on the invoice PDF.\n",
                    "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`\nis set to `true`\n, 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`\nand `line_item_taxes`\nare computed based on the tax configuration as of `invoice_date`.\nWhen passing this parameter, the following prerequisites must be met:\n\n* `invoice_date` must be in the past.\n* It is not earlier than `start_date`.\n* 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.\n* `invoice_immediately` is true. .\n",
                    "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/v2/pcv-1/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).\nThe 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
                  },
                  "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.\n",
                    "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)\nattribute of the [plan](/docs/api/v2/pcv-1/subscriptions/create-a-subscription#plan_id)\nchosen.\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`\nor a custom value depending on the [site configuration](https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms)\n.\n",
                    "maximum" : 100,
                    "minimum" : 1,
                    "example" : null
                  },
                  "trial_end_action" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Applicable only when [End-of-trial Action](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)\nhas 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.\n\n* cancel_subscription - The subscription cancels.\n* plan_default -\n  The action [configured for the site](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)\n  at the time when the trial ends, takes effect.\n* activate_subscription - The subscription activates and charges are raised for non-metered items.\n* site_default -\n  This is the default value. The action [configured for the site](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)\n  at the time when the trial ends, takes effect.\n",
                    "enum" : [ "site_default", "plan_default", "activate_subscription", "cancel_subscription" ],
                    "example" : null
                  },
                  "client_profile_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Indicates the Client profile id for the customer. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)\nintegration.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "payment_initiator" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The type of initiator to be used for the payment request triggered by this operation.\n\n* customer - Pass this value to indicate that the request is initiated by the customer\n* merchant - Pass this value to indicate that the request is initiated by the merchant\n",
                    "enum" : [ "customer", "merchant" ],
                    "example" : null
                  },
                  "customer" : {
                    "type" : "object",
                    "additionalProperties" : true,
                    "deprecated" : false,
                    "description" : "Parameters for customer\n",
                    "properties" : {
                      "id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The unique ID of the customer for which this `subscription`\nresource should be created.\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.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "First name of the customer\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Last name of the customer\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "company" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Company name of the customer.\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Phone number of the customer\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.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "taxability" : {
                        "type" : "string",
                        "default" : "taxable",
                        "deprecated" : false,
                        "description" : "Specifies if the customer is liable for tax\n\n* 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.\n* taxable -\n  Computes tax for the customer based on the [site configuration](https://www.chargebee.com/docs/tax.html).\n  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.\n* exempt -\n  * 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.\n  * 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.\n",
                        "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)\n.\n\n* med2 - US Medical Device Excise Tax with taxable sales tax\n* med1 - US Medical Device Excise Tax with exempt sales tax\n* b - State government\n* c - Tribe/Status Indian/Indian Band\n* a - Federal government\n* f - Religious organization\n* g - Resale\n* d - Foreign diplomat\n* e - Charitable or benevolent organization\n* j - Direct pay permit\n* k - Direct mail\n* h - Commercial agricultural production\n* i - Industrial production/manufacturer\n* n - Local government\n* l - Other or custom\n* m - Educational organization\n* r - Non-resident\n* p - Commercial aquaculture\n* q - Commercial Fishery\n",
                        "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)\n.\n",
                        "maxLength" : 100,
                        "example" : null
                      },
                      "net_term_days" : {
                        "type" : "integer",
                        "format" : "int32",
                        "default" : 0,
                        "deprecated" : false,
                        "description" : "The number of days within which the customer has to make payment for the invoice.\n",
                        "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.\n\n* other - Other\n* government - Government\n* wholesale - Whole-sale\n",
                        "enum" : [ "wholesale", "government", "other" ],
                        "example" : null
                      },
                      "auto_collection" : {
                        "type" : "string",
                        "default" : "on",
                        "deprecated" : false,
                        "description" : "Whether payments needs to be collected automatically for this customer\n\n* on - Whenever an invoice is created, an automatic attempt to charge the customer's payment method is made.\n* off - Automatic collection of charges will not be made. All payments must be recorded offline.\n",
                        "enum" : [ "on", "off" ],
                        "example" : null
                      },
                      "offline_payment_method" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The preferred offline payment method for the subscription.\n\n* check - Check\n* custom - Custom\n* cash - Cash\n* no_preference - No Preference\n* sepa_credit - SEPA Credit\n* us_automated_bank_transfer - US Automated Bank Transfer\n* bank_transfer - Bank Transfer\n* eu_automated_bank_transfer - EU Automated Bank Transfer\n* boleto - Boleto\n* uk_automated_bank_transfer - UK Automated Bank Transfer\n* ach_credit - ACH Credit\n* mx_automated_bank_transfer - MX Automated Bank Transfer\n* jp_automated_bank_transfer - JP Automated Bank Transfer\n",
                        "enum" : [ "no_preference", "cash", "check", "bank_transfer", "ach_credit", "sepa_credit", "boleto", "us_automated_bank_transfer", "eu_automated_bank_transfer", "uk_automated_bank_transfer", "jp_automated_bank_transfer", "mx_automated_bank_transfer", "custom" ],
                        "example" : null
                      },
                      "allow_direct_debit" : {
                        "type" : "boolean",
                        "default" : false,
                        "deprecated" : false,
                        "description" : "Whether the customer can pay via Direct Debit\n",
                        "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
                      },
                      "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)\n\n`country`\nas\n`XI`\n(which is **United Kingdom - Northern Ireland**\n), the first two characters of the [full VAT number](https://en.wikipedia.org/wiki/VAT_identification_number)\ncan be overridden by setting\n[vat_number_prefix](/docs/api/customers/customer-object#vat_number_prefix)\n.\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).\nOnly applicable specifically for customers with [billing_address](/docs/api/customers/customer-object#billing_address)\n\n`country`\nas `XI`\n(which is **United Kingdom - Northern Ireland**\n).\n\nWhen you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\nin 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\nthe Brexit configuration, you have the option of setting [billing_address](/docs/api/customers/customer-object#billing_address)\n\n`country`\nas `XI`.\nThat's the code for **United Kingdom - Northern Ireland** .\nThe first two characters of the VAT number in such a case is\n`XI`\nby default. However, if the VAT number was registered in UK, the value should be `GB`.\nSet\n`vat_number_prefix`\nto `GB`\nfor such cases.\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)\nof 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`.\nCurrently 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
                      },
                      "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.\n\n* automatic - Use this value to send e-invoice every time an invoice or credit note is created.\n* manual - When manual is selected the automatic e-invoice sending is disabled. Use this value to send e-invoice manually through UI or API.\n* site_default - The default value of the site which can be overridden at the customer level.\n",
                        "enum" : [ "automatic", "manual", "site_default" ],
                        "example" : null
                      },
                      "registered_for_gst" : {
                        "type" : "boolean",
                        "deprecated" : false,
                        "description" : "Confirms that a customer is registered under GST. If set to `true`\nthen the [Reverse Charge Mechanism](https://www.chargebee.com/docs/australian-gst.html#reverse-charge-mechanism)\nis applicable. This field is applicable only when Australian GST is configured for your site.\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",
                        "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)\nintegration.\nTo 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/)\n.\n",
                        "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)\nintegration.\n\n* business - When the purchase is made at a place of business\n* industrial - When the purchase is made by an industrial business\n* 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\n* residential - When the purchase is made by a customer for home use\n",
                        "enum" : [ "residential", "business", "senior_citizen", "industrial" ],
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "card" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for card\n",
                    "properties" : {
                      "gateway_account_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The gateway account in which this payment source is stored.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Cardholder's first name\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Cardholder's last name\n",
                        "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)\n, 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.\n",
                        "maximum" : 12,
                        "minimum" : 1,
                        "example" : null
                      },
                      "expiry_year" : {
                        "type" : "integer",
                        "format" : "int32",
                        "deprecated" : false,
                        "description" : "Card expiry year.\n",
                        "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)\n, you can specify the Braintree encrypted CVV here.\n",
                        "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* dankort - A Dankort card scheme. Supported only for Adyen and Chargebee Payments.\n* mastercard - A MasterCard 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.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "billing_addr2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2, as available in card billing address.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "billing_city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "City, as available in card billing address.\n",
                        "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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `billing_state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "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`\nis provided.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "billing_zip" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Postal or Zip code, as available in card billing address.\n",
                        "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).\n\n  * `payer`: User related information.\n    * `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).\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n    * `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.\n* `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.\n\n  * `fraud`: Fraud identification related information.\n    * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n* `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.\n\n  * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.\n* `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.\n\n  * `payer`: User related information.\n    * `document`: Document is the user's identification number based on their country.\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "bank_account" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for bank_account\n",
                    "properties" : {
                      "gateway_account_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The gateway account in which this payment source is stored.\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)\nplatform, this can be the [local bank details](https://developer.gocardless.com/api-reference/#appendix-local-bank-details)\n",
                        "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.\n",
                        "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.\n",
                        "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.\n",
                        "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.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Phone number of the account holder that is linked to the bank account.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "bank_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Name of account holder's bank.\n",
                        "maxLength" : 100,
                        "example" : null
                      },
                      "account_number" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Account holder's bank account number.\n",
                        "maxLength" : 17,
                        "minLength" : 4,
                        "example" : null
                      },
                      "routing_number" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Bank account routing number.\n",
                        "maxLength" : 9,
                        "minLength" : 3,
                        "example" : null
                      },
                      "bank_code" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Indicates the bank code.\n",
                        "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/)\nACH and Razorpay NetBanking users only. If not passed, account type is taken as null.\n\n* checking - Checking Account\n* business_checking - Business Checking Account\n* savings - Savings Account\n* current - Current Account\n",
                        "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.\n\n* individual - Individual Account.\n* company - Company Account.\n",
                        "enum" : [ "individual", "company" ],
                        "example" : null
                      },
                      "echeck_type" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "For Authorize.net ACH users only. Indicates the type of eCheck.\n\n* ppd - Payment Authorization is prearranged between the customer and the merchant.\n* web - Payment Authorization obtained from the customer via the internet.\n* ccd - Payment Authorization agreement from the corporate customer is required. Applicable for business_checking account_type.\n",
                        "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)\nISO country code. Required when local bank details are provided, and not IBAN.\n",
                        "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.\n",
                        "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.\n\n* `last_name`:(string, max chars=150) The last name of the contact.\n* `company_name`:(string, max chars=250) The company name for the address.\n* `line1`:(string, max chars=180) The first line of the address.\n* `line2`:(string, max chars=180) The second line of the address.\n* `country`:(string) The name of the country for the address.\n* `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.\n* `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.\n* `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`).\n* `city`:(string, max chars=50) The city name for the address.\n* `postal_code`:(string, max chars=20) The postal or ZIP code for the address.\n* `phone`:(string, max chars=50) The contact phone number for the address.\n* `email`:(string, max chars=70) The contact email address for the address.\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "payment_method" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for payment_method\n",
                    "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)\nAPI under Customer resource.\n\n* grab_pay - Payments made via GrabPay\n* nequi - Payments made via Nequi.\n* twint - Payments made via Twint\n* netbanking_emandates - Netbanking (eMandates) Payments.\n* giropay - Payments made via giropay.\n* direct_debit - Represents bank account for which the direct debit or ACH agreement/mandate is created.\n* ovo - Payments made via OVO.\n* mercado_pago - Payments made via Mercado Pago.\n* bancontact - Payments made via Bancontact Card.\n* pay_to - Payments made via PayTo\n* picpay - Payments made via PicPay.\n* kakao_pay - Payments made via Kakao Pay.\n* dotpay - Payments made via Dotpay.\n* p24 - Payments made via Przelewy24 (P24).\n* klarna - Payments made via Klarna.\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* venmo - Payments made via Venmo\n* payconiq_by_bancontact - Payments made via Payconiq by Bancontact.\n* wero - Payments made via Wero.\n* automated_bank_transfer - Represents virtual bank account using which the payment will be done.\n* amazon_payments - Payments made via Amazon Payments.\n* online_banking_poland - Payments made via Online Banking Poland\n* nupay - Payments made via NuPay.\n* go_pay - Payments made via GoPay\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* apple_pay - Payments made via Apple Pay.\n* unionpay - Payments made via UnionPay.\n* rakuten_pay - Payments made via Rakuten Pay.\n* paypay - Payments made via PayPay\n* south_korean_cards - Payments made via South Korean Cards\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_co - Payments made via PayCo\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* 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* thai_qr - Payments made via Thai QR.\n* swish - Payments made via Swish\n* naver_pay - Payments made via Naver Pay.\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* 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* 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.\n",
                        "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* .\nFor 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:**\nThis is not the one-time temporary token provided by gateways like Stripe.\n\nFor more details refer [Update payment method for a customer](/docs/api/customers/update-payment-method-for-a-customer)\nAPI under Customer resource.\n",
                        "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.\n",
                        "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)\n.\n\n**Note**:\nIf you enter an invalid country code, the system will return an error.\n\nIf you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\nin 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\nthe Brexit configuration, then `XI`\n(the code for **United Kingdom - Northern Ireland**\n) 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).\n\n  * `payer`: User related information.\n    * `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).\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n    * `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.\n* `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.\n\n  * `fraud`: Fraud identification related information.\n    * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n* `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.\n\n  * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.\n* `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.\n\n  * `payer`: User related information.\n    * `document`: Document is the user's identification number based on their country.\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "payment_intent" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for payment_intent\n",
                    "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.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "gateway_account_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The gateway account used for performing the 3DS flow.\n",
                        "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)\nto find out the gateway-specific gw_token format. Applicable when you are using gateway APIs directly for completing the 3DS flow.\n",
                        "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.\n\n* twint - Payments made via Twint\n* upi - upi\n* google_pay - google_pay\n* pix - Pix\n* wechat_pay - Payments made via WeChat Pay.\n* grab_pay - Payments made via GrabPay\n* sepa_instant_transfer - Sepa Instant Transfer\n* affirm_pay - Payments made via Affirm Pay.\n* kakao_pay - Payments made via Kakao Pay.\n* south_korean_cards - Payments made via South Korean Cards\n* trustly - Trustly\n* venmo - Venmo\n* alipay - Payments made via Alipay.\n* tamara - Payments made via Tamara.\n* pay_to - PayTo\n* rakuten_pay - Payments made via Rakuten Pay.\n* nequi - Payments made via Nequi.\n* wero - Payments made via Wero.\n* apple_pay - apple_pay\n* online_banking_poland - Online Banking Poland\n* nupay - Payments made via NuPay.\n* giropay - giropay\n* amazon_payments - Amazon Payments\n* fpx - Payments made via FPX.\n* card - card\n* dotpay - dotpay\n* faster_payments - Faster Payments\n* kbc_payment_button - KBC Payment Button\n* klarna - Payments made via Klarna.\n* payme - Payments made via PayMe\n* paypal_express_checkout - paypal_express_checkout\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* after_pay - Payments made via Afterpay\n* mercado_pago - Payments made via Mercado Pago.\n* direct_debit - direct_debit\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* blik - Payments made via BLIK.\n* dana - Payments made via Dana.\n* swish - Payments made via Swish\n* thai_qr - Payments made via Thai QR.\n* go_pay - Payments made via GoPay\n* naver_pay - Payments made via Naver Pay.\n* stablecoin - Payments made via Stablecoin.\n* pay_co - Payments made via PayCo\n* cash_app_pay - Payments made via Cash App Pay.\n* alipay_hk - Payments made via Alipay HK.\n* netbanking_emandates - netbanking_emandates\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* pay_by_bank - Pay By Bank\n* gcash - Payments made via GCash.\n* sofort - sofort\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.\n",
                        "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).\n\n  * `payer`: User related information.\n    * `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).\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n    * `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.\n* `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.\n\n  * `fraud`: Fraud identification related information.\n    * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n* `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.\n\n  * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.\n* `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.\n\n  * `payer`: User related information.\n    * `document`: Document is the user's identification number based on their country.\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "billing_address" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for billing_address\n",
                    "properties" : {
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The first name of the billing contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The last name of the billing contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "The email address.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "company" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The company name.\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The phone number.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line3" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 3\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "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`\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.\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.  \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.\n\n* valid - Address was validated successfully.\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* not_validated - Address is not yet validated.\n* invalid - Address is invalid.\n",
                        "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "shipping_address" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for shipping_address\n",
                    "properties" : {
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The first name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The last name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "The email address.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "company" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The company name.\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The phone number.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line3" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 3\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "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`\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.\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://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.\n\n* not_validated - Address is not yet validated.\n* valid - Address was validated successfully.\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n",
                        "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "statement_descriptor" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for statement_descriptor\n",
                    "properties" : {
                      "descriptor" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Payment transaction descriptor text to help your customer easily recognize the transaction. When this value is passed this will override the [transaction descriptor](https://www.chargebee.com/docs/1.0/transaction_descriptors.html)\ntext configured in the Chargebee site for all the subscription renewal transactions.\n",
                        "maxLength" : 65000,
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "contract_term" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for contract_term\n",
                    "properties" : {
                      "action_at_term_end" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Action to be taken when the contract term completes.\n\n* cancel - Contract term completes and subscription is canceled.\n* evergreen - Contract term completes and the subscription renews.\n* renew -\n  * 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).\n  * The `action_at_term_end` for the new contract term is set to `renew`.\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`](/docs/api/contract_terms/contract_term-object#contract_end)\n, 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.\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "entity_identifiers" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for entity_identifiers\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "The unique id for the `entity_identifier`\nin Chargebee. When not provided, it is autogenerated.\n",
                        "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)\nof 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\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",
                          "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",
                    "properties" : {
                      "provider_name" : {
                        "type" : "array",
                        "description" : "Name of the tax provider.\n",
                        "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.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "field_value" : {
                        "type" : "array",
                        "description" : "The value of the corresponding tax field.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "Identifier of the addon. Multiple addons can be passed.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "default" : 1,
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_in_decimal" : {
                        "type" : "array",
                        "description" : "The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 33,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price" : {
                        "type" : "array",
                        "description" : "Addon Unit Amount for create subscription\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price_in_decimal" : {
                        "type" : "array",
                        "description" : "Addon Unit Amount in Decimal for create subscription\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      },
                      "billing_cycles" : {
                        "type" : "array",
                        "description" : "Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "trial_end" : {
                        "type" : "array",
                        "description" : "The time at which the trial ends for the addon. This value can only be set for subscriptions that start with an `active`\nor `non-renewing`\nstatus. Once set, the value can't be changed. (Addon trial periods must be enabled by [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",
                        "items" : {
                          "type" : "integer",
                          "format" : "unix-time",
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "event_based_addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for event_based_addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "A unique 'id' used to identify the addon.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price" : {
                        "type" : "array",
                        "description" : "Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_in_decimal" : {
                        "type" : "array",
                        "description" : "The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 33,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price_in_decimal" : {
                        "type" : "array",
                        "description" : "When [price overriding](http://chargebee.com/docs/price-override.html )\nis enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)\nis used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      },
                      "service_period_in_days" : {
                        "type" : "array",
                        "description" : "Defines service period of the addon in days from the day of charge.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "maximum" : 4000,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "on_event" : {
                        "type" : "array",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "description" : "Event on which this addon will be charged.\n\n* subscription_trial_start - Addon will be charged when the trial period starts.\n* contract_termination - Addon will be charged on contract termination.\n* subscription_creation - Addon will be charged on subscription creation.\n* plan_activation - Addon will be charged on plan activation.\n* subscription_activation - Addon will be charged on subscription activation.\n",
                          "enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ],
                          "example" : null
                        },
                        "example" : null
                      },
                      "charge_once" : {
                        "type" : "array",
                        "description" : "If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.\n",
                        "items" : {
                          "type" : "boolean",
                          "default" : true,
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      },
                      "charge_on" : {
                        "type" : "array",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "description" : "Indicates when the non-recurring addon will be charged.\n\n* immediately - Charges for the addon will be applied immediately.\n* on_event - Charge for the addon will be applied on the occurrence of a specified event.\n",
                          "enum" : [ "immediately", "on_event" ],
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  }
                },
                "required" : [ "plan_id" ],
                "example" : null
              },
              "encoding" : {
                "addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "bank_account" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "billing_address" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "card" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "contract_term" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "customer" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "entity_identifiers" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "event_based_addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "payment_intent" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "payment_method" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "shipping_address" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "statement_descriptor" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "tax_providers_fields" : {
                  "style" : "deepObject",
                  "explode" : true
                }
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "subscription" : {
                      "$ref" : "#/components/schemas/Subscription",
                      "description" : "Resource object representing subscription\n"
                    },
                    "customer" : {
                      "$ref" : "#/components/schemas/Customer",
                      "description" : "Resource object representing customer\n"
                    },
                    "card" : {
                      "$ref" : "#/components/schemas/Card",
                      "description" : "Resource object representing card\n"
                    },
                    "invoice" : {
                      "$ref" : "#/components/schemas/Invoice",
                      "description" : "Resource object representing invoice\n"
                    },
                    "unbilled_charges" : {
                      "type" : "array",
                      "description" : "Resource object representing unbilled_charge\n",
                      "items" : {
                        "$ref" : "#/components/schemas/UnbilledCharge",
                        "description" : "Resource object representing unbilled_charge"
                      },
                      "example" : null
                    }
                  },
                  "required" : [ "customer", "subscription" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/subscriptions/{subscription-id}/move" : {
      "post" : {
        "tags" : [ "subscriptions" ],
        "summary" : "Move a subscription",
        "description" : "Moves a subscription from one [customer](/docs/api/v2/pcv-1/customers) to another asynchronously. All related resources such as [unbilled_charge](/docs/api/v2/pcv-1/unbilled_charges), [invoice](/docs/api/v2/pcv-1/invoices), [credit_note](/docs/api/v2/pcv-1/credit_notes), and [transaction](/docs/api/v2/pcv-1/transactions) are also moved to the new customer.\n\nAfter moving, Chargebee adds a [comment](/docs/api/v2/pcv-1/comments) to the original `customer` resource to document the move, including the [to_customer_id](/docs/api/v2/pcv-1/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) is `on`, it might fail after this operation. Refer to the warning in [copy_payment_source](/docs/api/v2/pcv-1/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/1.0/finance-integration-index.html) or in [Chargebee RevRec](https://www.chargebee.com/docs/revrec/chargebee-billing-features.html).\n\n#### Prerequisites\n\n* The subscription should not be part of a `customer` resource that is within an account hierarchy [relationship](/docs/api/v2/pcv-1/customers/customer-object#relationship).\n* There must be no invoices with the [statuses](/docs/api/v2/pcv-1/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/1.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/v2/pcv-1/credit_notes/credit_note-object#status) `adjusted` or `refund_due` should be associated with the subscription.\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/v2/pcv-1/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/1.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" : "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",
                    "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/v2/pcv-1/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** :\nDeleting 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/v2/pcv-1/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)\nis enabled, auto-collection will fail, in turn preventing subscription renewal. To prevent auto-collection failure, [link a payment source](/docs/api/v2/pcv-1/subscriptions/override-billing-profile)\nto 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\n"
                    }
                  },
                  "required" : [ "subscription" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/customers/{customer-id}/import_subscription" : {
      "post" : {
        "tags" : [ "customers" ],
        "summary" : "Import subscription for customer",
        "description" : "Import the subscription details of a customer.\n",
        "operationId" : "import_subscription_for_customer",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "customer-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/customer-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "additionalProperties" : true,
                "properties" : {
                  "id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "A unique and immutable identifier for the subscription. If not provided, it is autogenerated.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "plan_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Identifier of the plan for this subscription.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "plan_quantity" : {
                    "type" : "integer",
                    "format" : "int32",
                    "default" : 1,
                    "deprecated" : false,
                    "description" : "Plan quantity for this subscription.\n",
                    "minimum" : 1,
                    "example" : null
                  },
                  "plan_quantity_in_decimal" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                    "maxLength" : 33,
                    "example" : null
                  },
                  "plan_unit_price" : {
                    "type" : "integer",
                    "format" : "int64",
                    "deprecated" : false,
                    "description" : "Amount that will override the Plan's default price. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                    "minimum" : 0,
                    "example" : null
                  },
                  "plan_unit_price_in_decimal" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "When [price overriding](http://chargebee.com/docs/price-override.html )\nis enabled for the site, the price or per-unit price of the plan can be set here. The value [set for the plan](/docs/api/v2/pcv-1/plans/plan-object#price)\nis used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                    "maxLength" : 39,
                    "example" : null
                  },
                  "setup_fee" : {
                    "type" : "integer",
                    "format" : "int64",
                    "deprecated" : false,
                    "description" : "Amount that will override the default setup fee. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                    "minimum" : 0,
                    "example" : null
                  },
                  "trial_end" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "The time at which the trial ends for this subscription. Can be specified to override the default trial period.If **'0'**\nis passed, the subscription will be activated immediately.\n",
                    "example" : null
                  },
                  "billing_cycles" : {
                    "type" : "integer",
                    "format" : "int32",
                    "deprecated" : false,
                    "description" : "Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.\n",
                    "minimum" : 0,
                    "example" : null
                  },
                  "start_date" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "The date/time at which the subscription is to start or has started. If not provided, the subscription starts immediately.\n",
                    "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.\n\n* on - Whenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.\n* off - Automatic collection of charges will not be made for this subscription. Use this for offline payments.\n",
                    "enum" : [ "on", "off" ],
                    "example" : null
                  },
                  "po_number" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Purchase order number for this subscription.\n",
                    "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)\n.\n",
                    "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.\n",
                    "maxLength" : 40,
                    "example" : null
                  },
                  "status" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Current state of the subscription.\n\n* future - The subscription is scheduled to start at a future date.\n* active - The subscription is active and will be charged for automatically based on the items in it.\n* cancelled - The subscription has been canceled and is no longer in service.\n* transferred - The subscription has been transferred to another business entity within the organization.\n* in_trial - The subscription is in trial.\n* non_renewing - The subscription will be canceled at the end of the current term.\n* paused -\n  The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html).\n  The subscription will not renew while in this state.\n",
                    "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.  \n**Note:**\n\nFor subscription status: `non_renewing`, `active`, and `paused`, `current_term_end` is required.\n\n.\n",
                    "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`\nis `paused`.\nWhen the `status`\nis `active`\nor `non_renewing`\n, it defaults to the current time.\n",
                    "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`\nsubscription, it implies that the subscription goes into `in_trial`\nwhen it starts.\n",
                    "example" : null
                  },
                  "cancelled_at" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "Time at which subscription was cancelled or is set to be cancelled.\n",
                    "example" : null
                  },
                  "started_at" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "Time at which the subscription was started. Is `null`\nfor `future`\nsubscriptions as it is yet to be started.\n",
                    "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`.\n\nThe following conditions must be satisfied when passing this parameter:\n\n* When `status` is `active`, `non_renewing`, or `paused`, `activated_at` must be on or after `trial_end` or `started_at`. Additionally, `activated_at` must be on or before `current_term_start`.\n* When `status` is `in_trial`, `activated_at` must precede `trial_start`\n\n#### Note:\n\nThis parameter should not be provided when passing `status` as `future` or `cancelled`.\n",
                    "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`\nstate, it is the date/time when the subscription was paused.\n",
                    "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.\n",
                    "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`\nor a custom value depending on the [site configuration](https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms)\n.\n",
                    "maximum" : 100,
                    "minimum" : 1,
                    "example" : null
                  },
                  "create_current_term_invoice" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "Set as `true`\nif you want an invoice to be created for the subscription.\n\n* The invoice will be created for the subscription only if it has an `active` or `non_renewing` status.\n* The period of the invoice is from `current_term_start` to `current_term_end`.\n* 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.\n",
                    "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)\ndisplayed on the invoice PDF.\n",
                    "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/v2/pcv-1/advanced-features)\n.\n",
                    "example" : null
                  },
                  "contract_term" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for contract_term\n",
                    "properties" : {
                      "id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Id that uniquely identifies the contract term in the site.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "created_at" : {
                        "type" : "integer",
                        "format" : "unix-time",
                        "deprecated" : false,
                        "description" : "The date when the contract term was created.\n",
                        "example" : null
                      },
                      "contract_start" : {
                        "type" : "integer",
                        "format" : "unix-time",
                        "deprecated" : false,
                        "description" : "The start date of the contract term\n",
                        "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.\n",
                        "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)\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 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)\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.\n\n* evergreen - Contract term completes and the subscription renews.\n* renew -\n  * 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).\n  * The `action_at_term_end` for the new contract term is set to `renew`.\n* renew_once -\n  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).\n\n  * The `action_at_term_end` for the new contract term is set to `cancel`.\n* cancel - Contract term completes and subscription is canceled.\n",
                        "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)\n, 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.\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "transaction" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for transaction\n",
                    "properties" : {
                      "amount" : {
                        "type" : "integer",
                        "format" : "int64",
                        "deprecated" : false,
                        "description" : "The payment transaction amount. This parameter should be passed only if the invoice is created for current term.\n",
                        "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 current term.\n\n* cash - Cash\n* custom - Custom\n* check - Check\n* bank_transfer - Bank Transfer\n* other - Payment Methods other than the above types\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. For example, check number in case of `check`\n`payment_method`.\nThis parameter should be passed only if the invoice is created for current term.\n",
                        "maxLength" : 100,
                        "example" : null
                      },
                      "date" : {
                        "type" : "integer",
                        "format" : "unix-time",
                        "deprecated" : false,
                        "description" : "The date of occurence of the transaction. This parameter should be passed only if the invoice is created for current term.\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "shipping_address" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for shipping_address\n",
                    "properties" : {
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The first name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The last name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "The email address.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "company" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The company name.\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The phone number.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line3" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 3\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "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`\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.\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://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.\n\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n* valid - Address was validated successfully.\n",
                        "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "Identifier of the addon. Multiple addons can be passed.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "default" : 1,
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_in_decimal" : {
                        "type" : "array",
                        "description" : "The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis 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 addon. The value depends on the [type of currency](/docs/api/getting-started).  \n**Note:**\n\nFor recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the [addon period](/docs/api/v2/pcv-1/addons/addon-object#period). For example, consider the following details:\n\n* The `unit_price` provided is $10\n* The addon billing period is 1 month.\n* The plan billing period is 3 months.\n* The addon is only billed for $10 on each subscription renewal.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price_in_decimal" : {
                        "type" : "array",
                        "description" : "When [price overriding](http://chargebee.com/docs/price-override.html )\nis enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)\nis used by default. However, the price provided here is considered as the price of the addon for an entire billing cycle of the subscription regardless of the value of the addon `period`.\nProvide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      },
                      "billing_cycles" : {
                        "type" : "array",
                        "description" : "Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "event_based_addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for event_based_addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "A unique 'id' used to identify the addon.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price" : {
                        "type" : "array",
                        "description" : "Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_in_decimal" : {
                        "type" : "array",
                        "description" : "The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 33,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price_in_decimal" : {
                        "type" : "array",
                        "description" : "When [price overriding](http://chargebee.com/docs/price-override.html )\nis enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)\nis used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      },
                      "service_period_in_days" : {
                        "type" : "array",
                        "description" : "Defines service period of the addon in days from the day of charge.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "maximum" : 4000,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "on_event" : {
                        "type" : "array",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "description" : "Event on which this addon will be charged.\n\n* plan_activation - Addon will be charged on plan activation.\n* contract_termination - Addon will be charged on contract termination.\n* subscription_activation - Addon will be charged on subscription activation.\n* subscription_creation - Addon will be charged on subscription creation.\n* subscription_trial_start - Addon will be charged when the trial period starts.\n",
                          "enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ],
                          "example" : null
                        },
                        "example" : null
                      },
                      "charge_once" : {
                        "type" : "array",
                        "description" : "If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.\n",
                        "items" : {
                          "type" : "boolean",
                          "default" : true,
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "charged_event_based_addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for charged_event_based_addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "Addon id.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "last_charged_at" : {
                        "type" : "array",
                        "description" : "Timestamp indicating when this add-on was last charged for this subscription.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "unix-time",
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  }
                },
                "required" : [ "plan_id", "status" ],
                "example" : null
              },
              "encoding" : {
                "addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "charged_event_based_addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "contract_term" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "event_based_addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "shipping_address" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "transaction" : {
                  "style" : "deepObject",
                  "explode" : true
                }
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "subscription" : {
                      "$ref" : "#/components/schemas/Subscription",
                      "description" : "Resource object representing subscription\n"
                    },
                    "customer" : {
                      "$ref" : "#/components/schemas/Customer",
                      "description" : "Resource object representing customer\n"
                    },
                    "card" : {
                      "$ref" : "#/components/schemas/Card",
                      "description" : "Resource object representing card\n"
                    },
                    "invoice" : {
                      "$ref" : "#/components/schemas/Invoice",
                      "description" : "Resource object representing invoice\n"
                    }
                  },
                  "required" : [ "customer", "subscription" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/customers/{customer-id}/subscriptions" : {
      "post" : {
        "tags" : [ "customers" ],
        "summary" : "Create subscription for customer",
        "description" : "**Note:**\nThis operation optionally supports 3DS verification flow. To achieve the same, create the [Payment Intent](/docs/api/getting-started)\nand pass it as input parameter to this API.\n\nCreates a new subscription for an existing customer. You can attach a plan, plan quantity, one or more addons and coupon while creating this subscription.\n\nIf the plan does not have a trial period and if any of the recurring-item has charges, then the customer is charged immediately if auto_collection is turned 'on'. In that case, subscription is created only if the customer has a payment method on file and attempted payment is successful.  \nIf an invoice gets generated during this operation, available Credits and Excess Payments will be automatically applied.\n",
        "operationId" : "create_subscription_for_customer",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "customer-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/customer-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "additionalProperties" : true,
                "properties" : {
                  "id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "A unique and immutable identifier for the subscription. If not provided, it is autogenerated.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "brand_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "maxLength" : 50,
                    "example" : null
                  },
                  "plan_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Identifier of the plan for this subscription.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "plan_quantity" : {
                    "type" : "integer",
                    "format" : "int32",
                    "default" : 1,
                    "deprecated" : false,
                    "description" : "Plan quantity for this subscription.\n",
                    "minimum" : 1,
                    "example" : null
                  },
                  "plan_quantity_in_decimal" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                    "maxLength" : 33,
                    "example" : null
                  },
                  "plan_unit_price" : {
                    "type" : "integer",
                    "format" : "int64",
                    "deprecated" : false,
                    "description" : "Amount that will override the Plan's default price. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                    "minimum" : 0,
                    "example" : null
                  },
                  "plan_unit_price_in_decimal" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "When [price overriding](http://chargebee.com/docs/price-override.html )\nis enabled for the site, the price or per-unit price of the plan can be set here. The value [set for the plan](/docs/api/v2/pcv-1/plans/plan-object#price)\nis used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                    "maxLength" : 39,
                    "example" : null
                  },
                  "setup_fee" : {
                    "type" : "integer",
                    "format" : "int64",
                    "deprecated" : false,
                    "description" : "Amount that will override the default setup fee. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                    "minimum" : 0,
                    "example" : null
                  },
                  "trial_end" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "The time at which the trial ends for this subscription. Can be specified to override the default trial period.If **'0'**\nis passed, the subscription will be activated immediately.\n",
                    "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/v2/pcv-1/contract_terms) or not.\n\n* When the subscription is not on a contract term: if `billing_cycles` is not provided, then the billing cycles [set for the plan](/docs/api/v2/pcv-1/plans/plan-object#billing_cycles) is used. Moreover, once the `billing_cycles` have completed, the subscription cancels.\n* 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.\n",
                    "minimum" : 0,
                    "example" : null
                  },
                  "mandatory_addons_to_remove" : {
                    "type" : "array",
                    "deprecated" : false,
                    "description" : "List of addons IDs that are mandatory to the plan and has to be removed from the subscription.\n",
                    "items" : {
                      "type" : "string",
                      "deprecated" : false,
                      "maxLength" : 100,
                      "example" : null
                    },
                    "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:\n\n* Backdating is enabled for subscription creation operations.\n* 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.\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, `start_date` cannot be earlier than 14th February. .\n",
                    "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.\n\n* on - Whenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.\n* off - Automatic collection of charges will not be made for this subscription. Use this for offline payments.\n",
                    "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)\n.\n",
                    "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)\nfor Calendar Billing. Only applicable when using Calendar Billing. The default value is that which has been configured for the site.\n\n* immediate - Subscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..\n* delayed - Subscription period will be aligned with the configured billing date at the next renewal.\n",
                    "enum" : [ "immediate", "delayed" ],
                    "example" : null
                  },
                  "offline_payment_method" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The preferred offline payment method for the subscription.\n\n* jp_automated_bank_transfer - JP Automated Bank Transfer\n* sepa_credit - SEPA Credit\n* cash - Cash\n* no_preference - No Preference\n* uk_automated_bank_transfer - UK Automated Bank Transfer\n* custom - Custom\n* bank_transfer - Bank Transfer\n* boleto - Boleto\n* check - Check\n* mx_automated_bank_transfer - MX Automated Bank Transfer\n* us_automated_bank_transfer - US Automated Bank Transfer\n* eu_automated_bank_transfer - EU Automated Bank Transfer\n* ach_credit - ACH Credit\n",
                    "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.\n",
                    "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.\n",
                    "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.\n",
                    "maxLength" : 40,
                    "example" : null
                  },
                  "override_relationship" : {
                    "type" : "boolean",
                    "deprecated" : false,
                    "description" : "If `true`\n, ignores the [hierarchy relationship](/docs/api/customers/customer-object#relationship)\nand uses customer as payment and invoice owner.\n",
                    "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)\ndisplayed on the invoice PDF.\n",
                    "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`\nis set to `true`\n, 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`\nand `line_item_taxes`\nare computed based on the tax configuration as of `invoice_date`.\nWhen passing this parameter, the following prerequisites must be met:\n\n* `invoice_date` must be in the past.\n* It is not earlier than `start_date`.\n* 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.\n* `invoice_immediately` is true. .\n",
                    "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/v2/pcv-1/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).\nThe 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.\nIn case of Create Subscription for Customer endpoint, the default value is True. Otherwise, the default value is False.\n",
                    "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.\n",
                    "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)\nattribute of the [plan](/docs/api/v2/pcv-1/subscriptions/create-a-subscription#plan_id)\nchosen.\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`\nor a custom value depending on the [site configuration](https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms)\n.\n",
                    "maximum" : 100,
                    "minimum" : 1,
                    "example" : null
                  },
                  "trial_end_action" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Applicable only when [End-of-trial Action](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)\nhas 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.\n\n* cancel_subscription - The subscription cancels.\n* activate_subscription - The subscription activates and charges are raised for non-metered items.\n* plan_default -\n  The action [configured for the site](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)\n  at the time when the trial ends, takes effect.\n* site_default -\n  This is the default value. This is the default value. The action [configured for the site](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)\n  at the time when the trial ends, takes effect.\n",
                    "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.\n\n* customer - Pass this value to indicate that the request is initiated by the customer\n* merchant - Pass this value to indicate that the request is initiated by the merchant\n",
                    "enum" : [ "customer", "merchant" ],
                    "example" : null
                  },
                  "shipping_address" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for shipping_address\n",
                    "properties" : {
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The first name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The last name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "The email address.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "company" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The company name.\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The phone number.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line3" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 3\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "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`\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.\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://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.\n\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n* valid - Address was validated successfully.\n",
                        "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "statement_descriptor" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for statement_descriptor\n",
                    "properties" : {
                      "descriptor" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Payment transaction descriptor text to help your customer easily recognize the transaction. When this value is passed this will override the [transaction descriptor](https://www.chargebee.com/docs/1.0/transaction_descriptors.html)\ntext configured in the Chargebee site for all the subscription renewal transactions.\n",
                        "maxLength" : 65000,
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "payment_intent" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for payment_intent\n",
                    "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.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "gateway_account_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The gateway account used for performing the 3DS flow.\n",
                        "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)\nto find out the gateway-specific gw_token format. Applicable when you are using gateway APIs directly for completing the 3DS flow.\n",
                        "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.\n\n* card - card\n* twint - Payments made via Twint\n* swish - Payments made via Swish\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* thai_qr - Payments made via Thai QR.\n* go_pay - Payments made via GoPay\n* google_pay - google_pay\n* trustly - Trustly\n* naver_pay - Payments made via Naver Pay.\n* stablecoin - Payments made via Stablecoin.\n* paypal_express_checkout - paypal_express_checkout\n* pix - Pix\n* venmo - Venmo\n* klarna_pay_now - Klarna Pay Now\n* alipay - Payments made via Alipay.\n* tamara - Payments made via Tamara.\n* ideal - ideal\n* picpay - Payments made via PicPay.\n* pay_to - PayTo\n* ovo - Payments made via OVO.\n* boleto - boleto\n* pay_co - Payments made via PayCo\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* alipay_hk - Payments made via Alipay HK.\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* mercado_pago - Payments made via Mercado Pago.\n* p24 - Payments made via Przelewy24 (P24).\n* electronic_payment_standard - Electronic Payment Standard\n* direct_debit - direct_debit\n* sepa_instant_transfer - Sepa Instant Transfer\n* bancontact - bancontact\n* wero - Payments made via Wero.\n* pay_by_bank - Pay By Bank\n* touch_n_go - Payments made via Touch 'n Go.\n* apple_pay - apple_pay\n* qpay - Payments made via Qpay.\n* online_banking_poland - Online Banking Poland\n* gcash - Payments made via GCash.\n* nupay - Payments made via NuPay.\n* giropay - giropay\n* momo - Payments made via MoMo.\n* sofort - sofort\n* amazon_payments - Amazon Payments\n* affirm_pay - Payments made via Affirm Pay.\n* kakao_pay - Payments made via Kakao Pay.\n* fpx - Payments made via FPX.\n* blik - Payments made via BLIK.\n* dana - Payments made via Dana.\n* south_korean_cards - Payments made via South Korean Cards\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.\n",
                        "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).\n\n  * `payer`: User related information.\n    * `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).\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n    * `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.\n* `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.\n\n  * `fraud`: Fraud identification related information.\n    * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n* `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.\n\n  * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.\n* `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.\n\n  * `payer`: User related information.\n    * `document`: Document is the user's identification number based on their country.\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "contract_term" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for contract_term\n",
                    "properties" : {
                      "action_at_term_end" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Action to be taken when the contract term completes.\n\n* evergreen - Contract term completes and the subscription renews.\n* renew -\n  * 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).\n  * 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`](/docs/api/contract_terms/contract_term-object#contract_end)\n, 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.\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "Identifier of the addon. Multiple addons can be passed.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "default" : 1,
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_in_decimal" : {
                        "type" : "array",
                        "description" : "The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 33,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price" : {
                        "type" : "array",
                        "description" : "Sub Item Plan Unit Amount for create subscription\n",
                        "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\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      },
                      "billing_cycles" : {
                        "type" : "array",
                        "description" : "Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "trial_end" : {
                        "type" : "array",
                        "description" : "The time at which the trial ends for the addon. This value can only be set for subscriptions that start with an `active`\nor `non-renewing`\nstatus. Once set, the value can't be changed. (Addon trial periods must be enabled by [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",
                        "items" : {
                          "type" : "integer",
                          "format" : "unix-time",
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "event_based_addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for event_based_addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "A unique 'id' used to identify the addon.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price" : {
                        "type" : "array",
                        "description" : "Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_in_decimal" : {
                        "type" : "array",
                        "description" : "The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 33,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price_in_decimal" : {
                        "type" : "array",
                        "description" : "When [price overriding](http://chargebee.com/docs/price-override.html )\nis enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)\nis used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      },
                      "service_period_in_days" : {
                        "type" : "array",
                        "description" : "Defines service period of the addon in days from the day of charge.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "maximum" : 4000,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "on_event" : {
                        "type" : "array",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "description" : "Event on which this addon will be charged.\n\n* plan_activation - Addon will be charged on plan activation.\n* contract_termination - Addon will be charged on contract termination.\n* subscription_activation - Addon will be charged on subscription activation.\n* subscription_creation - Addon will be charged on subscription creation.\n* subscription_trial_start - Addon will be charged when the trial period starts.\n",
                          "enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ],
                          "example" : null
                        },
                        "example" : null
                      },
                      "charge_once" : {
                        "type" : "array",
                        "description" : "If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.\n",
                        "items" : {
                          "type" : "boolean",
                          "default" : true,
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      },
                      "charge_on" : {
                        "type" : "array",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "description" : "Indicates when the non-recurring addon will be charged.\n\n* immediately - Charges for the addon will be applied immediately.\n* on_event - Charge for the addon will be applied on the occurrence of a specified event.\n",
                          "enum" : [ "immediately", "on_event" ],
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  }
                },
                "required" : [ "plan_id" ],
                "example" : null
              },
              "encoding" : {
                "addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "contract_term" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "event_based_addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "payment_intent" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "shipping_address" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "statement_descriptor" : {
                  "style" : "deepObject",
                  "explode" : true
                }
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "subscription" : {
                      "$ref" : "#/components/schemas/Subscription",
                      "description" : "Resource object representing subscription\n"
                    },
                    "customer" : {
                      "$ref" : "#/components/schemas/Customer",
                      "description" : "Resource object representing customer\n"
                    },
                    "card" : {
                      "$ref" : "#/components/schemas/Card",
                      "description" : "Resource object representing card\n"
                    },
                    "invoice" : {
                      "$ref" : "#/components/schemas/Invoice",
                      "description" : "Resource object representing invoice\n"
                    },
                    "unbilled_charges" : {
                      "type" : "array",
                      "description" : "Resource object representing unbilled_charge\n",
                      "items" : {
                        "$ref" : "#/components/schemas/UnbilledCharge",
                        "description" : "Resource object representing unbilled_charge"
                      },
                      "example" : null
                    }
                  },
                  "required" : [ "customer", "subscription" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/subscriptions/{subscription-id}/retrieve_advance_invoice_schedule" : {
      "get" : {
        "tags" : [ "subscriptions" ],
        "summary" : "Retrieve advance invoice",
        "description" : "Retrieves the *advance_invoice_schedule* for a subscription. Note that this endpoint is only applicable for *schedule_type = specific_dates* or fixed_intervals.\n",
        "operationId" : "retrieve_advance_invoice",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "subscription-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/subscription-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "advance_invoice_schedules" : {
                      "type" : "array",
                      "description" : "Resource object representing advance_invoice_schedule\n",
                      "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" : "**Note:** Cannot be called when the subscription is on a [contract term](/docs/api/contract_terms). (That is, when the `contract_term.status attribute` is `active`.)\n\nIf the subscription is in **Non Renewing** or **In Trial** state and is also scheduled to cancel at the end of current term, then this API can be used to remove the scheduled cancellation. When a scheduled cancellation is removed, the subscription will revert to **Active** or **In Trial** state, whichever is the state before cancellation was scheduled.\n\nWhile removing the scheduled cancellation, you may specify the number of billing cycles. If the billing cycle is not specified, the default billing cycle from the plan will be applied on the subscription.\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" : "subscription-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/subscription-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "billing_cycles" : {
                    "type" : "integer",
                    "format" : "int32",
                    "deprecated" : false,
                    "description" : "Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.\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`\nor a custom value depending on the [site configuration](https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms)\n.\n",
                    "maximum" : 100,
                    "minimum" : 1,
                    "example" : null
                  },
                  "contract_term" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for contract_term\n",
                    "properties" : {
                      "action_at_term_end" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Action to be taken when the contract term completes.\n\n* cancel - Contract term completes and subscription is canceled.\n* evergreen - Contract term completes and the subscription renews.\n* renew -\n  * 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).\n  * The `action_at_term_end` for the new contract term is set to `renew`.\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`](/docs/api/contract_terms/contract_term-object#contract_end)\n, 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.\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" : {
                    "subscription" : {
                      "$ref" : "#/components/schemas/Subscription",
                      "description" : "Resource object representing subscription\n"
                    },
                    "customer" : {
                      "$ref" : "#/components/schemas/Customer",
                      "description" : "Resource object representing customer\n"
                    },
                    "card" : {
                      "$ref" : "#/components/schemas/Card",
                      "description" : "Resource object representing card\n"
                    }
                  },
                  "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 with scheduled changes",
        "description" : "Retrieves a subscription with the scheduled changes applied. If the subscription has one or more [`ramp`](ramps)s, this API returns the subscription with the upcoming ramp applied.\n\n**Note:** Only the following attributes are changed\n\n* plan_id\n* plan_quantity\n* plan_unit_price\n* setup_fee\n* billing_period\n* billing_period_unit\n* plan_free_quantity\n* remaining_billing_cycles\n* addons\n* coupons Other attributes such as **status** ,**next_billing_at** are not changed and will reflect the current subscription values.\n",
        "operationId" : "retrieve_with_scheduled_changes",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "subscription-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/subscription-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "subscription" : {
                      "$ref" : "#/components/schemas/Subscription",
                      "description" : "Resource object representing subscription\n"
                    },
                    "customer" : {
                      "$ref" : "#/components/schemas/Customer",
                      "description" : "Resource object representing customer\n"
                    },
                    "card" : {
                      "$ref" : "#/components/schemas/Card",
                      "description" : "Resource object representing card\n"
                    }
                  },
                  "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" : "**Note:**\nThis operation optionally supports 3DS verification flow. To achieve the same, create the [Payment Intent](/docs/api/getting-started)\nand pass it as input parameter to this API.\n\nThis API is used to reactivate a **cancelled** subscription. You may also optionally specify a trial end date, to move the subscription to **In Trial** state. If trial end is not specified, the subscription will be activated and any applicable charges will be initiated.\n\nUnless the billing cycle is specified, it will be set to plan's default billing cycle.\n\nDuring an in-term reactivation++, unless the billing cycle is specified, the subscription's remaining billing cycles will be restored. If a trial end date is specified, then the plan's default billing cycle is used.\n\n**What is an \"in-term reactivation\"?**\n\nAn \"in-term reactivation\" happens when the billing term of the subscription is retained upon cancellation and reactivation is initiated within that term.\n\n**When is the 'billing term' retained for a cancelled subscription?**\n\nWhen dunning (payment failure retry settings) is configured with the last retry configured as\n\n* cancel subscription and mark invoice as 'Not Paid', or\n* cancel subscription and mark the invoice as 'Voided' and the case if any of the current term invoices is partially or fully paid, the invoice is not voided but instead Chargebee marks the invoices as 'Not Paid'.\n\n**Note :** In both cases, the billing term is retained and upon reactivation the subscription will be moved to active state (if the plan does not have a trial period) and no invoice will be generated. Ensure that you collect any unpaid invoices.\n\n**Example :** A Subscription was billed from 1st to 31st of a month and it was cancelled on the 20th due to one of the above cases (billing term is not reset). If the reactivation happens on 25th then it is considered an in-term reactivation.  \nReactivation of a subscription in **non_renewing** state has been deprecated. To remove a scheduled cancellation of a **non_renewing** Subscription, use [Remove Scheduled Cancellation](/docs/api/subscriptions/remove-scheduled-cancellation) API.\nHowever, if you use reactivate API to remove scheduled cancellation for a **non_renewing** Subscription, then the status will be set to **active** and the billing cycle will be set to forever. If any value is passed for trial_end or billing cycle, an error will be thrown.\nIf an invoice gets generated during this operation, available Credits and Excess Payments will be automatically applied.\n**Additional Error Scenarios:** If there is a need to create an immediate charge and the collection fails, an error will be thrown.\n",
        "operationId" : "reactivate_a_subscription",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "subscription-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/subscription-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "trial_end" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "Providing this parameter indicates that the subscription reactivates with an `in_trial`\n`status`\nand the trial period ends at the date provided. The value must not be earlier than `reactivate_from`.\nNote: This parameter can be backdated (set to a value in the past) only when `reactivate_from`\nhas been backdated. Do this to keep a record of when the trial ended in case it ended at some point in the past. When `trial_end`\nis backdated, the subscription immediately goes into `active`\nor `non_renewing`\nstatus.\n",
                    "example" : null
                  },
                  "billing_cycles" : {
                    "type" : "integer",
                    "format" : "int32",
                    "deprecated" : false,
                    "description" : "Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.\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. The value of this parameter must always be in the past (backdating). Do this when the subscription has already been reactivated and the billing has been delayed. The following prerequisites must be met for this parameter to be passed:\n\n* The backdating feature 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* 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, `reactivate_from` cannot be earlier than 14th February. .\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).\nThe 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*\nterm gets started during this operation. Unless specified the configured *default*\nvalue will be used.\n\n* delayed - Subscription period will be aligned with the configured billing date at the next renewal.\n* immediate - Subscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..\n",
                    "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).\nIf a new term is started for the subscription due to this API call, then `terms_to_charge`\nis inclusive of this new term. See description for the `force_term_reset`\nparameter to learn more about when a subscription term is reset.\n",
                    "minimum" : 1,
                    "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`\nis `true`\n, 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`\nand `line_item_taxes`\nare computed based on the tax configuration as of `invoice_date`.\nWhen passing this parameter, the following prerequisites must be met:\n\n* `invoice_date` must be in the past.\n* `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.\n* It is not earlier than `reactivate_from` or `trial_end`.\n* `invoice_immediately` is `true`. .\n",
                    "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`\nor a custom value depending on the [site configuration](https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms)\n.\n",
                    "maximum" : 100,
                    "minimum" : 1,
                    "example" : null
                  },
                  "payment_initiator" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The type of initiator to be used for the payment request triggered by this operation.\n\n* customer - Pass this value to indicate that the request is initiated by the customer\n* merchant - Pass this value to indicate that the request is initiated by the merchant\n",
                    "enum" : [ "customer", "merchant" ],
                    "example" : null
                  },
                  "contract_term" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for contract_term\n",
                    "properties" : {
                      "action_at_term_end" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Action to be taken when the contract term completes.\n\n* evergreen - Contract term completes and the subscription renews.\n* renew -\n  * 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).\n  * 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`](/docs/api/contract_terms/contract_term-object#contract_end)\n, 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.\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "statement_descriptor" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for statement_descriptor\n",
                    "properties" : {
                      "descriptor" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Payment transaction descriptor text to help your customer easily recognize the transaction. When this value is passed this will override the [transaction descriptor](https://www.chargebee.com/docs/1.0/transaction_descriptors.html)\ntext configured in the Chargebee site for all the subscription renewal transactions.\n",
                        "maxLength" : 65000,
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "payment_intent" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for payment_intent\n",
                    "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.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "gateway_account_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The gateway account used for performing the 3DS flow.\n",
                        "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)\nto find out the gateway-specific gw_token format. Applicable when you are using gateway APIs directly for completing the 3DS flow.\n",
                        "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.\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.\n",
                        "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).\n\n  * `payer`: User related information.\n    * `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).\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n    * `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.\n* `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.\n\n  * `fraud`: Fraud identification related information.\n    * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n* `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.\n\n  * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.\n* `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.\n\n  * `payer`: User related information.\n    * `document`: Document is the user's identification number based on their country.\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device\n",
                        "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\n"
                    },
                    "customer" : {
                      "$ref" : "#/components/schemas/Customer",
                      "description" : "Resource object representing customer\n"
                    },
                    "card" : {
                      "$ref" : "#/components/schemas/Card",
                      "description" : "Resource object representing card\n"
                    },
                    "invoice" : {
                      "$ref" : "#/components/schemas/Invoice",
                      "description" : "Resource object representing invoice\n"
                    },
                    "unbilled_charges" : {
                      "type" : "array",
                      "description" : "Resource object representing unbilled_charge\n",
                      "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" : "Create advance invoice or invoicing schedules",
        "description" : "Creates an advance invoice or an [advance invoicing schedule](/docs/api/advance_invoice_schedules). When an advance invoice is generated, and [`auto_collection`](/docs/api/v2/pcv-1/subscriptions/subscription-object#auto_collection) is `on` for the subscription, the [`payment_source`](/docs/api/subscriptions/subscription-object#payment_source_id) associated with the subscription is charged. Any changes scheduled for the subscription are taken into account automatically while generating an advance invoice. Advance invoices are not generated for a subscription when it is in the [`paused`](/docs/api/subscriptions/subscription-object#status) status.  \n* This operation is supported only on select plans. To know more, take a look at our [plans and pricing page](https://www.chargebee.com/pricing/).\n* This operation is not supported for `non_renewing` and `cancelled` subscriptions.\n* This operation is not supported if an advance invoice is already present. You could void/delete that invoice and try creating another 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" : "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`.\n* 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. .\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).\nApplicable only when [`schedule_type`](/docs/api/subscriptions/charge-future-renewals#schedule_type)\nis `immediate`\n.\n",
                    "example" : null
                  },
                  "schedule_type" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The type of advance invoice or advance invoicing schedule.\n\n* immediate -\n  Charge immediately for the number of billing cycles specified by [`terms_to_charge`](/docs/api/subscriptions/charge-future-renewals#terms_to_charge)\n  .\n* specific_dates -\n  Charge on [specific dates](/docs/api/subscriptions/charge-future-renewals#specific_dates_schedule_date).\n  For each date, specify the [number of billing cycles](/docs/api/subscriptions/charge-future-renewals#specific_dates_schedule_terms_to_charge)\n  to charge for. Up to 5 dates can be configured.\n* fixed_intervals -\n  Charge at fixed intervals of time. Specify the [number of billing cycles](/docs/api/subscriptions/charge-future-renewals#terms_to_charge)\n  that constitute an interval and the number of [days before each interval](/docs/api/subscriptions/charge-future-renewals#fixed_interval_schedule_days_before_renewal)\n  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)\n  .\n",
                    "enum" : [ "immediate", "specific_dates", "fixed_intervals" ],
                    "example" : null
                  },
                  "fixed_interval_schedule" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for fixed_interval_schedule\n",
                    "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)\nof 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)\n= `after_number_of_intervals`\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",
                        "minimum" : 1,
                        "example" : null
                      },
                      "end_schedule_on" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Specifies when the schedule should end.\n\n* after_number_of_intervals - Advance invoices are generated a `specified number of times`\n* subscription_end - Advance invoices are generated for as long as the subscription is active.\n* specific_date -\n  End the advance invoicing schedule on a `specific date`\n  .\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 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)\n= `specific_date`\n.\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "specific_dates_schedule" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for specific_dates_schedule\n",
                    "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)\nis specific_dates.\n",
                        "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)\nis `specific_dates`\n.\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\n"
                    },
                    "customer" : {
                      "$ref" : "#/components/schemas/Customer",
                      "description" : "Resource object representing customer\n"
                    },
                    "card" : {
                      "$ref" : "#/components/schemas/Card",
                      "description" : "Resource object representing card\n"
                    },
                    "invoice" : {
                      "$ref" : "#/components/schemas/Invoice",
                      "description" : "Resource object representing invoice\n"
                    },
                    "advance_invoice_schedules" : {
                      "type" : "array",
                      "description" : "Resource object representing advance_invoice_schedule\n",
                      "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" : "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)\n.\n",
                    "minimum" : 1,
                    "example" : null
                  },
                  "description" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Description for this charge.\n",
                    "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 ).\nProvide the value in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                    "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)\nintegration.\n\n* retail - Transaction is a sale to an end user\n* wholesale - Transaction is a sale to another company that will resell your product or service to another consumer\n* vendor_use - Transaction is for an item that is subject to vendor use tax\n* consumed - Transaction is for an item that is consumed directly\n",
                    "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)\nintegration.\n",
                    "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)\nintegration.\n",
                    "example" : null
                  },
                  "date_from" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "The time when the service period for the charge starts.\n",
                    "example" : null
                  },
                  "date_to" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "The time when the service period for the charge ends.\n",
                    "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\n"
                    }
                  },
                  "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",
        "description" : "Removes the subscription changes scheduled on next renewal. Advance charges, if any, will be refunded as credits and a new invoice will be generated on renewal.\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" : "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\n"
                    },
                    "customer" : {
                      "$ref" : "#/components/schemas/Customer",
                      "description" : "Resource object representing customer\n"
                    },
                    "card" : {
                      "$ref" : "#/components/schemas/Card",
                      "description" : "Resource object representing card\n"
                    },
                    "credit_notes" : {
                      "type" : "array",
                      "description" : "Resource object representing credit_note\n",
                      "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" : "Changes the subscription's current term end date. Depending on the \"status\" of the subscription, \"term end date\" has different effects.\n\n* If the Subscription is in **trial**, it affects trial end date.\n* If the Subscription is **active**, it affects the next billing date.\n* If the Subscription's status is **non_renewing**, this affects the upcoming cancellation date.\n\n**Tip**: To cycle through a couple of billing cycles and test webhooks, you may use this API.  \n* When changing the *term_end* for *active* / *non_renewing* subscriptions, by default no additional charges (when term gets extended) will be added or credits (when term gets reduced) will be issued. However you can specify *prorate* param as *true* for adding prorated charges / issuing prorated credits. Further for the charges that got added, you can specify *invoice_immediately* as *false* to add them to *unbilled charges* and invoice them later.\n* Advance charges, if any will be credited back during this operation.\n* Confirm the UTC (Coordinated Universal Time) time zone selected in your Chargebee site matches with your country region.\n",
        "operationId" : "change_term_end",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "subscription-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/subscription-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "term_ends_at" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "The time at which the current term should end for this subscription.\n",
                    "example" : null
                  },
                  "prorate" : {
                    "type" : "boolean",
                    "deprecated" : false,
                    "description" : "Applicable for *active*\n/ *non_renewing*\nsubscriptions. If specified as *true*\nprorated charges / credits will be added during this operation.\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).\nThe 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\n"
                    },
                    "customer" : {
                      "$ref" : "#/components/schemas/Customer",
                      "description" : "Resource object representing customer\n"
                    },
                    "card" : {
                      "$ref" : "#/components/schemas/Card",
                      "description" : "Resource object representing card\n"
                    },
                    "invoice" : {
                      "$ref" : "#/components/schemas/Invoice",
                      "description" : "Resource object representing invoice\n"
                    },
                    "unbilled_charges" : {
                      "type" : "array",
                      "description" : "Resource object representing unbilled_charge\n",
                      "items" : {
                        "$ref" : "#/components/schemas/UnbilledCharge",
                        "description" : "Resource object representing unbilled_charge"
                      },
                      "example" : null
                    },
                    "credit_notes" : {
                      "type" : "array",
                      "description" : "Resource object representing credit_note\n",
                      "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 the subscription resource.  \nThis operation is irreversible - all data related to the subscription, such as invoices, transactions, and reports, will be deleted.\n**Note:** This operation schedules the subscription resource for deletion. It will be deleted in a few minutes.\n",
        "operationId" : "delete_a_subscription",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "subscription-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/subscription-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "subscription" : {
                      "$ref" : "#/components/schemas/Subscription",
                      "description" : "Resource object representing subscription\n"
                    },
                    "customer" : {
                      "$ref" : "#/components/schemas/Customer",
                      "description" : "Resource object representing customer\n"
                    },
                    "card" : {
                      "$ref" : "#/components/schemas/Card",
                      "description" : "Resource object representing card\n"
                    }
                  },
                  "required" : [ "customer", "subscription" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/subscriptions/import_subscription" : {
      "post" : {
        "tags" : [ "subscriptions" ],
        "summary" : "Import a subscription",
        "description" : "Imports a subscription into Chargebee.\n",
        "operationId" : "import_a_subscription",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "additionalProperties" : true,
                "properties" : {
                  "id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Id for the new subscription. If not given, this will be auto-generated.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "client_profile_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Indicates the Client profile id for the customer. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)\nintegration.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "plan_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Identifier of the plan for this subscription.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "plan_quantity" : {
                    "type" : "integer",
                    "format" : "int32",
                    "default" : 1,
                    "deprecated" : false,
                    "description" : "Plan quantity for this subscription.\n",
                    "minimum" : 1,
                    "example" : null
                  },
                  "plan_quantity_in_decimal" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                    "maxLength" : 33,
                    "example" : null
                  },
                  "plan_unit_price" : {
                    "type" : "integer",
                    "format" : "int64",
                    "deprecated" : false,
                    "description" : "Amount that will override the Plan's default price. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                    "minimum" : 0,
                    "example" : null
                  },
                  "plan_unit_price_in_decimal" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "When [price overriding](http://chargebee.com/docs/price-override.html )\nis enabled for the site, the price or per-unit price of the plan can be set here. The value [set for the plan](/docs/api/v2/pcv-1/plans/plan-object#price)\nis used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                    "maxLength" : 39,
                    "example" : null
                  },
                  "setup_fee" : {
                    "type" : "integer",
                    "format" : "int64",
                    "deprecated" : false,
                    "description" : "Amount that will override the default setup fee. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                    "minimum" : 0,
                    "example" : null
                  },
                  "trial_end" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "The time at which the trial ends for this subscription. Can be specified to override the default trial period.If **'0'**\nis passed, the subscription will be activated immediately.\n",
                    "example" : null
                  },
                  "billing_cycles" : {
                    "type" : "integer",
                    "format" : "int32",
                    "deprecated" : false,
                    "description" : "Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.\n",
                    "minimum" : 0,
                    "example" : null
                  },
                  "start_date" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "The date/time at which the subscription is to start or has started. If not provided, the subscription starts immediately.\n",
                    "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.\n\n* on - Whenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.\n* off - Automatic collection of charges will not be made for this subscription. Use this for offline payments.\n",
                    "enum" : [ "on", "off" ],
                    "example" : null
                  },
                  "po_number" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Purchase order number for this subscription.\n",
                    "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.\n",
                    "items" : {
                      "type" : "string",
                      "deprecated" : false,
                      "maxLength" : 100,
                      "example" : null
                    },
                    "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`\nor a custom value depending on the [site configuration](https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms)\n.\n",
                    "maximum" : 100,
                    "minimum" : 1,
                    "example" : null
                  },
                  "status" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Current state of the subscription.\n\n* future - The subscription is scheduled to start at a future date.\n* non_renewing - The subscription will be canceled at the end of the current term.\n* active - The subscription is active and will be charged for automatically based on the items in it.\n* cancelled - The subscription has been canceled and is no longer in service.\n* transferred - The subscription has been transferred to another business entity within the organization.\n* in_trial - The subscription is in trial.\n* paused -\n  The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html).\n  The subscription will not renew while in this state.\n",
                    "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.  \n**Note:**\n\nFor subscription status: `non_renewing`, `active`, and `paused`, `current_term_end` is required.\n\n.\n",
                    "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`\nis `paused`.\nWhen the `status`\nis `active`\nor `non_renewing`\n, it defaults to the current time.\n",
                    "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`\nsubscription, it implies that the subscription goes into `in_trial`\nwhen it starts.\n",
                    "example" : null
                  },
                  "cancelled_at" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "Time at which subscription was cancelled or is set to be cancelled.\n",
                    "example" : null
                  },
                  "started_at" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "Time at which the subscription was started. Is `null`\nfor `future`\nsubscriptions as it is yet to be started.\n",
                    "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`.\n\nThe following conditions must be satisfied when passing this parameter:\n\n* When `status` is `active`, `non_renewing`, or `paused`, `activated_at` must be on or after `trial_end` or `started_at`. Additionally, `activated_at` must be on or before `current_term_start`.\n* When `status` is `in_trial`, `activated_at` must precede `trial_start`\n\n#### Note:\n\nThis parameter should not be provided when passing `status` as `future` or `cancelled`.\n",
                    "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`\nstate, it is the date/time when the subscription was paused.\n",
                    "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.\n",
                    "example" : null
                  },
                  "create_current_term_invoice" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "Set as `true`\nif you want an invoice to be created for the subscription.\n\n* The invoice will be created for the subscription only if it has an `active` or `non_renewing` status.\n* The period of the invoice is from `current_term_start` to `current_term_end`.\n* 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.\n",
                    "example" : null
                  },
                  "affiliate_token" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "A unique tracking token.\n",
                    "maxLength" : 250,
                    "example" : null
                  },
                  "invoice_notes" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "A customer-facing note added to all invoices associated with this subscription. This note is one among [all the notes](/docs/api/invoices/invoice-object#notes)\ndisplayed on the invoice PDF.\n",
                    "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/v2/pcv-1/advanced-features)\n.\n",
                    "example" : null
                  },
                  "customer" : {
                    "type" : "object",
                    "additionalProperties" : true,
                    "deprecated" : false,
                    "description" : "Parameters for customer\n",
                    "properties" : {
                      "id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The unique ID of the customer for which this `hosted_page`\nshould be created. When not provided, a new customer is created with the ID set to the value provided for `subscription[id]`.\nIf `subscription[id]`\nis unavailable, then the customer ID is autogenerated.\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.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "First name of the customer\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Last name of the customer\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "company" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Company name of the customer.\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Phone number of the customer\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.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "taxability" : {
                        "type" : "string",
                        "default" : "taxable",
                        "deprecated" : false,
                        "description" : "Specifies if the customer is liable for tax\n\n* exempt -\n  * 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.\n  * 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.\n* 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.\n* taxable -\n  Computes tax for the customer based on the [site configuration](https://www.chargebee.com/docs/tax.html).\n  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.\n",
                        "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)\n.\n\n* med2 - US Medical Device Excise Tax with taxable sales tax\n* med1 - US Medical Device Excise Tax with exempt sales tax\n* b - State government\n* c - Tribe/Status Indian/Indian Band\n* a - Federal government\n* f - Religious organization\n* g - Resale\n* d - Foreign diplomat\n* e - Charitable or benevolent organization\n* j - Direct pay permit\n* k - Direct mail\n* h - Commercial agricultural production\n* i - Industrial production/manufacturer\n* n - Local government\n* l - Other or custom\n* m - Educational organization\n* r - Non-resident\n* p - Commercial aquaculture\n* q - Commercial Fishery\n",
                        "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)\n.\n",
                        "maxLength" : 100,
                        "example" : null
                      },
                      "net_term_days" : {
                        "type" : "integer",
                        "format" : "int32",
                        "default" : 0,
                        "deprecated" : false,
                        "description" : "The number of days within which the customer has to make payment for the invoice.\n",
                        "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.\n\n* wholesale - Whole-sale\n* other - Other\n* government - Government\n",
                        "enum" : [ "wholesale", "government", "other" ],
                        "example" : null
                      },
                      "customer_type" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Indicates the type of the customer. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)\nintegration.\n\n* 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\n* business - When the purchase is made at a place of business\n* residential - When the purchase is made by a customer for home use\n* industrial - When the purchase is made by an industrial business\n",
                        "enum" : [ "residential", "business", "senior_citizen", "industrial" ],
                        "example" : null
                      },
                      "auto_collection" : {
                        "type" : "string",
                        "default" : "on",
                        "deprecated" : false,
                        "description" : "Whether payments needs to be collected automatically for this customer\n\n* on - Whenever an invoice is created, an automatic attempt to charge the customer's payment method is made.\n* off - Automatic collection of charges will not be made. All payments must be recorded offline.\n",
                        "enum" : [ "on", "off" ],
                        "example" : null
                      },
                      "allow_direct_debit" : {
                        "type" : "boolean",
                        "default" : false,
                        "deprecated" : false,
                        "description" : "Whether the customer can pay via Direct Debit\n",
                        "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)\n\n`country`\nas\n`XI`\n(which is **United Kingdom - Northern Ireland**\n), the first two characters of the [full VAT number](https://en.wikipedia.org/wiki/VAT_identification_number)\ncan be overridden by setting\n[vat_number_prefix](/docs/api/customers/customer-object#vat_number_prefix)\n.\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).\nOnly applicable specifically for customers with [billing_address](/docs/api/customers/customer-object#billing_address)\n\n`country`\nas `XI`\n(which is **United Kingdom - Northern Ireland**\n).\n\nWhen you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\nin 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\nthe Brexit configuration, you have the option of setting [billing_address](/docs/api/customers/customer-object#billing_address)\n\n`country`\nas `XI`.\nThat's the code for **United Kingdom - Northern Ireland** .\nThe first two characters of the VAT number in such a case is\n`XI`\nby default. However, if the VAT number was registered in UK, the value should be `GB`.\nSet\n`vat_number_prefix`\nto `GB`\nfor such cases.\n",
                        "maxLength" : 10,
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "contract_term" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for contract_term\n",
                    "properties" : {
                      "id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Id that uniquely identifies the contract term in the site.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "created_at" : {
                        "type" : "integer",
                        "format" : "unix-time",
                        "deprecated" : false,
                        "description" : "The date when the contract term was created.\n",
                        "example" : null
                      },
                      "contract_start" : {
                        "type" : "integer",
                        "format" : "unix-time",
                        "deprecated" : false,
                        "description" : "The start date of the contract term\n",
                        "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.\n",
                        "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)\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 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)\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.\n\n* renew_once -\n  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).\n\n  * The `action_at_term_end` for the new contract term is set to `cancel`.\n* cancel - Contract term completes and subscription is canceled.\n* evergreen - Contract term completes and the subscription renews.\n* renew -\n  * 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).\n  * The `action_at_term_end` for the new contract term is set to `renew`.\n",
                        "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)\n, 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.\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "card" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for card\n",
                    "properties" : {
                      "gateway_account_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The gateway account in which this payment source is stored.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Cardholder's first name\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Cardholder's last name\n",
                        "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)\n, 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.\n",
                        "maximum" : 12,
                        "minimum" : 1,
                        "example" : null
                      },
                      "expiry_year" : {
                        "type" : "integer",
                        "format" : "int32",
                        "deprecated" : false,
                        "description" : "Card expiry year.\n",
                        "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)\n, you can specify the Braintree encrypted CVV here.\n",
                        "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.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "billing_addr2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2, as available in card billing address.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "billing_city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "City, as available in card billing address.\n",
                        "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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `billing_state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "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`\nis provided.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "billing_zip" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Postal or Zip code, as available in card billing address.\n",
                        "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).\n\n  * `payer`: User related information.\n    * `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).\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n    * `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.\n* `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.\n\n  * `fraud`: Fraud identification related information.\n    * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n* `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.\n\n  * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.\n* `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.\n\n  * `payer`: User related information.\n    * `document`: Document is the user's identification number based on their country.\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "payment_method" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for payment_method\n",
                    "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)\nAPI 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* 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* 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* electronic_payment_standard - Electronic Payment Standard\n* affirm_pay - Payments made via Affirm Pay.\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* swish - Payments made via Swish\n* thai_qr - Payments made via Thai QR.\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* momo - Payments made via MoMo.\n* blik - Payments made via BLIK.\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.\n",
                        "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* .\nFor 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:**\nThis is not the one-time temporary token provided by gateways like Stripe.\n\nFor more details refer [Update payment method for a customer](/docs/api/customers/update-payment-method-for-a-customer)\nAPI under Customer resource.\n",
                        "maxLength" : 200,
                        "example" : null
                      },
                      "issuing_country" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "[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\nIf you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\nin 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\nthe Brexit configuration, then `XI`\n(the code for **United Kingdom - Northern Ireland**\n) 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).\n\n  * `payer`: User related information.\n    * `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).\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n    * `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.\n* `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.\n\n  * `fraud`: Fraud identification related information.\n    * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n* `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.\n\n  * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.\n* `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.\n\n  * `payer`: User related information.\n    * `document`: Document is the user's identification number based on their country.\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "billing_address" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for billing_address\n",
                    "properties" : {
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The first name of the billing contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The last name of the billing contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "The email address.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "company" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The company name.\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The phone number.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line3" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 3\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "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`\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.\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://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.\n\n* valid - Address was validated successfully.\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n",
                        "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "shipping_address" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for shipping_address\n",
                    "properties" : {
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The first name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The last name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "The email address.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "company" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The company name.\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The phone number.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line3" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 3\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "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`\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.\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://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.\n\n* not_validated - Address is not yet validated.\n* valid - Address was validated successfully.\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n",
                        "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "transaction" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for transaction\n",
                    "properties" : {
                      "amount" : {
                        "type" : "integer",
                        "format" : "int64",
                        "deprecated" : false,
                        "description" : "The payment transaction amount. This parameter should be passed only if the invoice is created for current term.\n",
                        "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 current term.\n\n* cash - Cash\n* custom - Custom\n* other - Payment Methods other than the above types\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. For example, check number in case of `check`\n`payment_method`.\nThis parameter should be passed only if the invoice is created for current term.\n",
                        "maxLength" : 100,
                        "example" : null
                      },
                      "date" : {
                        "type" : "integer",
                        "format" : "unix-time",
                        "deprecated" : false,
                        "description" : "The date of occurence of the transaction. This parameter should be passed only if the invoice is created for current term.\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "Identifier of the addon. Multiple addons can be passed.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "default" : 1,
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_in_decimal" : {
                        "type" : "array",
                        "description" : "The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis 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 addon. The value depends on the [type of currency](/docs/api/getting-started).  \n**Note:**\n\nFor recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the [addon period](/docs/api/v2/pcv-1/addons/addon-object#period). For example, consider the following details:\n\n* The `unit_price` provided is $10\n* The addon billing period is 1 month.\n* The plan billing period is 3 months.\n* The addon is only billed for $10 on each subscription renewal.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price_in_decimal" : {
                        "type" : "array",
                        "description" : "When [price overriding](http://chargebee.com/docs/price-override.html )\nis enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)\nis used by default. However, the price provided here is considered as the price of the addon for an entire billing cycle of the subscription regardless of the value of the addon `period`.\nProvide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      },
                      "billing_cycles" : {
                        "type" : "array",
                        "description" : "Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "event_based_addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for event_based_addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "A unique 'id' used to identify the addon.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price" : {
                        "type" : "array",
                        "description" : "Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_in_decimal" : {
                        "type" : "array",
                        "description" : "The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 33,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price_in_decimal" : {
                        "type" : "array",
                        "description" : "When [price overriding](http://chargebee.com/docs/price-override.html )\nis enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)\nis used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      },
                      "service_period_in_days" : {
                        "type" : "array",
                        "description" : "Defines service period of the addon in days from the day of charge.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "maximum" : 4000,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "on_event" : {
                        "type" : "array",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "description" : "Event on which this addon will be charged.\n\n* subscription_creation - Addon will be charged on subscription creation.\n* subscription_trial_start - Addon will be charged when the trial period starts.\n* plan_activation - Addon will be charged on plan activation.\n* contract_termination - Addon will be charged on contract termination.\n* subscription_activation - Addon will be charged on subscription activation.\n",
                          "enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ],
                          "example" : null
                        },
                        "example" : null
                      },
                      "charge_once" : {
                        "type" : "array",
                        "description" : "If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.\n",
                        "items" : {
                          "type" : "boolean",
                          "default" : true,
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "charged_event_based_addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for charged_event_based_addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "Addon id.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "last_charged_at" : {
                        "type" : "array",
                        "description" : "Timestamp indicating when this add-on was last charged for this subscription.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "unix-time",
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  }
                },
                "required" : [ "plan_id", "status" ],
                "example" : null
              },
              "encoding" : {
                "addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "billing_address" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "card" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "charged_event_based_addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "contract_term" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "customer" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "event_based_addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "payment_method" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "shipping_address" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "transaction" : {
                  "style" : "deepObject",
                  "explode" : true
                }
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "subscription" : {
                      "$ref" : "#/components/schemas/Subscription",
                      "description" : "Resource object representing subscription\n"
                    },
                    "customer" : {
                      "$ref" : "#/components/schemas/Customer",
                      "description" : "Resource object representing customer\n"
                    },
                    "card" : {
                      "$ref" : "#/components/schemas/Card",
                      "description" : "Resource object representing card\n"
                    },
                    "invoice" : {
                      "$ref" : "#/components/schemas/Invoice",
                      "description" : "Resource object representing invoice\n"
                    }
                  },
                  "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 unbilled charges into Chargebee.\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" : "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\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "Uniquely identifies an unbilled charge.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 40,
                          "example" : null
                        },
                        "example" : null
                      },
                      "date_from" : {
                        "type" : "array",
                        "description" : "Start date of this charge.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "unix-time",
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      },
                      "date_to" : {
                        "type" : "array",
                        "description" : "End date of this charge.\n",
                        "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.\n\n* plan -\n  Indicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)\n  id\n* plan_setup -\n  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)\n  id\n* adhoc - Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case\n* addon -\n  Indicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the [addon](/docs/api/v2/pcv-1/addons/addon-object)\n  id\n",
                          "enum" : [ "plan_setup", "plan", "addon", "adhoc" ],
                          "example" : null
                        },
                        "example" : null
                      },
                      "entity_id" : {
                        "type" : "array",
                        "description" : "The identifier of the modelled entity this charge is based on. Will be null for 'adhoc' entity type.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "description" : {
                        "type" : "array",
                        "description" : "Detailed description about this charge.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 250,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_amount" : {
                        "type" : "array",
                        "description" : "Unit amount of the charge item.\n",
                        "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.\n",
                        "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.\n",
                        "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`\nx `quantity_in_decimal`.\nReturned when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_in_decimal" : {
                        "type" : "array",
                        "description" : "The decimal representation of the quantity of this entity. Returned when the entity is quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 33,
                          "example" : null
                        },
                        "example" : null
                      },
                      "amount_in_decimal" : {
                        "type" : "array",
                        "description" : "The decimal representation of the unit amount for the entity. The value is in major units of the currency. Returned when the entity is quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      },
                      "discount_amount" : {
                        "type" : "array",
                        "description" : "Total discounts for this charge.\n",
                        "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.\n",
                        "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.\n",
                        "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\n",
                    "properties" : {
                      "unbilled_charge_id" : {
                        "type" : "array",
                        "description" : "Uniquely identifies an unbilled charge.\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.\n\n* document_level_coupon -\n  The deduction is due to a coupon applied to the invoice `sub_total`.\n  The coupon id is passed as `entity_id`\n  .\n* item_level_coupon -\n  The deduction is due to a coupon applied to line item. The coupon `id`\n  is passed as `entity_id`\n  .\n",
                          "enum" : [ "item_level_coupon", "document_level_coupon" ],
                          "example" : null
                        },
                        "example" : null
                      },
                      "entity_id" : {
                        "type" : "array",
                        "description" : "When the deduction is due to a `coupon`\n, then this is the `id`\nof the coupon. Is required when `discounts[entity_type]`\nis `item_level_coupon`\nor `document_level_coupon`\n.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "description" : {
                        "type" : "array",
                        "description" : "Description for this deduction.\n",
                        "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)\n.\n",
                        "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\n",
                    "properties" : {
                      "unbilled_charge_id" : {
                        "type" : "array",
                        "description" : "Uniquely identifies an unbilled charge.\n",
                        "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\n",
                        "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\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_used" : {
                        "type" : "array",
                        "description" : "The number of units purchased in a range.\n",
                        "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`\npricing , or the price of each unit in the tier if the charge model is `tiered`\n/`volume`\npricing.\n",
                        "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`\nof the next lower tier. Returned only when the `line_items.pricing_model`\nis `tiered`\n, `volume`\nor `stairstep`\nand [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis 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. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the `starting_unit_in_decimal`\nof the next higher tier. Returned only when the `line_items.pricing_model`\nis `tiered`\n, `volume`\nor stairstep and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "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`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "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`\nis `tiered`\nor `volume`.\nWhen the `pricing_model`\nis `stairstep`\n, it is the decimal representation of the total price for `line_item`.\nThe value is in major units of the currency. Returned when the `line_item`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "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\n",
                      "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",
        "operationId" : "remove_scheduled_resumption",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "subscription-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/subscription-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "subscription" : {
                      "$ref" : "#/components/schemas/Subscription",
                      "description" : "Resource object representing subscription\n"
                    },
                    "customer" : {
                      "$ref" : "#/components/schemas/Customer",
                      "description" : "Resource object representing customer\n"
                    },
                    "card" : {
                      "$ref" : "#/components/schemas/Card",
                      "description" : "Resource object representing card\n"
                    }
                  },
                  "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" : "**Important**\n\nFor sites where both [legacy and latest](/docs/api/v2/pcv-1/upgrade#retrieving-api-responses-in-latest-api-format) product catalog versions are active, GET API requests return responses in a `compat` format by default. This format works with both latest and legacy Product Catalog.\n\n**Override options:**\n\n* `chargebee-response-schema-type: items` → Return response in latest product catalog format only.\n* `chargebee-response-schema-type: plans_addons` → Return response in legacy product catalog format only.\n\nRetrieves details of a subscription.\n",
        "operationId" : "retrieve_a_subscription",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "subscription-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/subscription-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "subscription" : {
                      "$ref" : "#/components/schemas/Subscription",
                      "description" : "Resource object representing subscription\n"
                    },
                    "customer" : {
                      "$ref" : "#/components/schemas/Customer",
                      "description" : "Resource object representing customer\n"
                    },
                    "card" : {
                      "$ref" : "#/components/schemas/Card",
                      "description" : "Resource object representing card\n"
                    }
                  },
                  "required" : [ "customer", "subscription" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      },
      "post" : {
        "tags" : [ "subscriptions" ],
        "summary" : "Update a subscription",
        "description" : "**Note:**\n\n* This operation optionally supports 3DS verification flow. To achieve the same, create the [Payment Intent](/docs/api/getting-started) and pass it as input parameter to this API.\n* When the **Remove mandatory add-ons from old plan during subscription plan update** setting is [enabled](https://www.chargebee.com/docs/1.0/subscriptions.html#editing-a-subscription_remove-mandatory-addons) on your Chargebee site, all [mandatory addons](/docs/api/attached_items) with the old plan will be automatically removed during the subscription update to a new plan.\n\nYou can modify the plan, plan quantity and add or remove addons for the subscription. By default the changes are applied immediately and the charges (/credits) are prorated and adjusted with the next billing term. You may also choose to effect the changes at the end of the current term by passing **end_of_term** as \"true\". In this case proration will not be done.\n\nOnly the parameters that are passed are modified for the subscription. Rest will reflect the existing values.\n\nBy default, the addons passed are appended to the existing list of addons for this subscription. In case a passed addon already exists for this subscription, quantity value is replaced. If you want to completely replace the addons for this subscription, pass **replace_addon_list** as \"true\".\n\n[Card](/docs/api/cards/card-object) and 'vat_number' attributes can also be passed during subscription update. If they are passed, corresponding Billing Info attributes - the [Billing Address](/docs/api/customers/customer-object) and 'vat_number' - will be replaced automatically.\n\nPassing credit card details to this API involves PCI liability at your end as sensitive card info passes through your servers. If you wish to avoid that, you can use one of the following integration methodologies if applicable\n\n* If you are using Stripe gateway, you can use [Stripe.js](https://stripe.com/docs/stripe.js) with your checkout form. Take a look at this [Stripe tutorial](https://stripe.com/docs/payments/accept-a-payment-charges) for more details.\n* If you are using Braintree gateway, you can use [Braintree.js](https://www.braintreepayments.com/docs/javascript) with your checkout form. Please refer this [tutorial](https://www.chargebee.com/tutorials/braintree-js-example.html) for more details.\n* If you are using Authorize.Net gateway, you use [Accept.js](https://developer.authorize.net/api/reference/features/acceptjs.html) with your checkout form.\n* If you are using the Adyen gateway, you will have to use the Adyen's [Client Side Encryption](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/cse-integration-ecommerce) to encrypt sensitive cardholder data. Once the cardholder data is encrypted, pass the value in adyen.encrypted.data as temp token in this API.\n* You can also use our [Hosted Pages](https://www.chargebee.com/docs/billing/2.0/hosted-capabilities/hosted-capabilities) based integration.\n\n**Proration Scenario:** A customer changes from a $15 plan to $30 plan after 15 days of a monthly term. He will be charged for $7.50 immediately. The following Credit Note and Invoice will be generated  \n\n|-------------------------------|-------|\n| **Credit Note**               |\n| Prorated credits for Old Plan | $7.50 |\n\n|-------------------------------|---------|\n| **Invoice**                   |\n| Prorated charges for New Plan | $15.00  |\n| Total                         | $15.00  |\n| Credits                       | ($7.50) |\n| **Amount Due**                | $7.50   |\n\nMeanwhile downgrading will result in net credits being created which will be applied when the subscription is charged on start of the next term. Learn more about our proration scenarios [here](https://www.chargebee.com/docs/proration.html).\n\n**Billing Cycle:** The billing period for a subscription does not change if the plans intervals of both old and new are same. However, if a customer changes to a plan that has different billing interval(say monthly to yearly), the billing period is reset. Customer is charged immediately for the modified subscription after applying credit for the unused period for the old subscription.\n**Card and VAT number Input:** If they are passed, corresponding [Billing Address](/docs/api/customers/customer-object) attributes and [vat_number](/docs/api/customers/customer-object) will be replaced. i.e existing values for Billing Address and 'vat_number' will be cleared and the new values will be set.\nIf an invoice gets generated during this operation, available Credits and Excess Payments will be automatically applied.\n\n**Advance charges**, if any, will be refunded as credits and a new invoice will be generated on renewal.\n",
        "operationId" : "update_a_subscription",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "subscription-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/subscription-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "additionalProperties" : true,
                "properties" : {
                  "plan_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Identifier of the plan for this subscription.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "plan_quantity" : {
                    "type" : "integer",
                    "format" : "int32",
                    "default" : 1,
                    "deprecated" : false,
                    "description" : "Represents the plan quantity for this subscription.\n",
                    "minimum" : 1,
                    "example" : null
                  },
                  "plan_unit_price" : {
                    "type" : "integer",
                    "format" : "int64",
                    "deprecated" : false,
                    "description" : "Amount that will override the plan's default price. The unit depends on the [type of currency](/docs/api/getting-started).\nIf `changes_scheduled_at`\nis in the past and a `plan_unit_price`\nis not passed, then the plan's current unit price is considered even if the plan did not exist on the date as of when the change is scheduled.\n",
                    "minimum" : 0,
                    "example" : null
                  },
                  "setup_fee" : {
                    "type" : "integer",
                    "format" : "int64",
                    "deprecated" : false,
                    "description" : "Amount that will override the default setup fee. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                    "minimum" : 0,
                    "example" : null
                  },
                  "replace_addon_list" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "Should be true if the existing addons should be replaced with the ones that are being passed.\n",
                    "example" : null
                  },
                  "mandatory_addons_to_remove" : {
                    "type" : "array",
                    "deprecated" : false,
                    "description" : "A list of IDs representing the [mandatorily attached addons](/docs/api/attached_items)\nassociated with the plan to which the subscription is being updated. These addons will be removed from the subscription during the subscription update process.\n",
                    "items" : {
                      "type" : "string",
                      "deprecated" : false,
                      "maxLength" : 100,
                      "example" : null
                    },
                    "example" : null
                  },
                  "plan_quantity_in_decimal" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                    "maxLength" : 33,
                    "example" : null
                  },
                  "plan_unit_price_in_decimal" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "When [price overriding](https://www.chargebee.com/docs/price-override.html)\nis 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)\nis 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)\nis enabled. If `changes_scheduled_at`\nis in the past and a `unit_price_in_decimal`\nis 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.\n",
                    "maxLength" : 39,
                    "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`\nis set to `true`\n, 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`.\nWhen passing this parameter, the following prerequisites must be met:\n\n* `invoice_date` must be in the past.\n* `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.\n* It is not earlier than `changes_scheduled_at`, `reactivate_from`, or `trial_end`.\n* `invoice_immediately` is `true`. .\n",
                    "example" : null
                  },
                  "start_date" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "The new start date of a `future`\nsubscription. Applicable only for `future`\nsubscriptions.\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 it to `0` to have no trial period.  \n**Note**\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 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.\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 is used.\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).\nIf a new term is started for the subscription due to this API call, then `terms_to_charge`\nis inclusive of this new term. See description for the `force_term_reset`\nparameter to learn more about when a subscription term is reset.\n",
                    "minimum" : 1,
                    "example" : null
                  },
                  "reactivate_from" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "If the subscription `status`\nis `cancelled`\nand it is being reactivated via this operation, this is the date/time at which the subscription should be reactivated.\n**Note:**\nIt is recommended not to pass this parameter along with `changed_scheduled_at`.\n`reactivate_from`\ncan 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:\n\n* Backdating must be enabled for subscription reactivation operations.\n* 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.\n* The date is on or after the last date/time any of the product catalog items of the subscription were changed.\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
                  },
                  "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)\nchosen for the site for calendar billing. Only applicable when using calendar billing.\n\n* immediate - Subscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..\n* delayed - Subscription period will be aligned with the configured billing date at the next renewal.\n",
                    "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.\n\n* on - Whenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.\n* off - Automatic collection of charges will not be made for this subscription. Use this for offline payments.\n",
                    "enum" : [ "on", "off" ],
                    "example" : null
                  },
                  "offline_payment_method" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The preferred offline payment method for the subscription.\n\n* sepa_credit - SEPA Credit\n* cash - Cash\n* no_preference - No Preference\n* bank_transfer - Bank Transfer\n* check - Check\n* eu_automated_bank_transfer - EU Automated Bank Transfer\n* jp_automated_bank_transfer - JP Automated Bank Transfer\n* uk_automated_bank_transfer - UK Automated Bank Transfer\n* custom - Custom\n* boleto - Boleto\n* mx_automated_bank_transfer - MX Automated Bank Transfer\n* us_automated_bank_transfer - US Automated Bank Transfer\n* ach_credit - ACH Credit\n",
                    "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.\n",
                    "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).\nIf `changes_scheduled_at`\nis in the past, then the currently available coupons can be used even if they were not available as of the date for when the change is scheduled.\n",
                    "items" : {
                      "type" : "string",
                      "deprecated" : false,
                      "maxLength" : 100,
                      "example" : null
                    },
                    "example" : null
                  },
                  "replace_coupon_list" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "If `true`\nthen the existing `coupon_ids`\nlist for the subscription is replaced by the one provided. If `false`\nthen the provided list gets added to the existing `coupon_ids`\n.\n",
                    "example" : null
                  },
                  "prorate" : {
                    "type" : "boolean",
                    "deprecated" : false,
                    "description" : "* When `true`: [Prorated credits or charges](https://www.chargebee.com/docs/1.0/proration.html#proration-mechanism) are created as applicable for this change.\n* When `false`: The subscription is changed without creating any credits or charges.\n* When not provided, the value configured in the [site settings](https://www.chargebee.com/docs/1.0/proration.html#proration-for-subscription-change) is considered.\n\n**Caveat**\n\nFor further changes within the same billing term, when `prorate` is set to `true`, **credits** are **not created** when **all** the conditions below hold true:\n\nAn immediate previous change was made\n\n* with `prorate` set to `false` and\n* no changes were made to the subscription's billing term and\n* a change was made to either the subscription's plan, its addons, or the prices of the plan or addons.\n",
                    "example" : null
                  },
                  "end_of_term" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "Set this to true if you want the update to be applied at the end of the current subscription billing cycle.\n",
                    "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`\nwill have the subscription reset its term to the current date (provided `end_of_term`\nis false).\n**Note**:\nWhen 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.\n",
                    "example" : null
                  },
                  "reactivate" : {
                    "type" : "boolean",
                    "deprecated" : false,
                    "description" : "When the `status`\nof the subscription is `cancelled`\n, this parameter determines whether the subscription is reactivated upon making this API request. Unless passed explicitly as `false`\n, this parameter is implied as `true`\nwhen you provide `plan_id`\nor `addons[id]`\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/1.0/payment-gateways-and-configuration/gateway_settings#smart-routing).\nExplicitly 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)\ndisplayed on the invoice PDF.\n",
                    "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/v2/pcv-1/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).\nThe 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
                  },
                  "override_relationship" : {
                    "type" : "boolean",
                    "deprecated" : false,
                    "description" : "If `true`\n, ignores the [hierarchy relationship](/docs/api/customers/customer-object#relationship)\nand uses customer as payment and invoice owner.\n",
                    "example" : null
                  },
                  "changes_scheduled_at" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "When `change_option`\nis set to `specific_date`\n, then set the date/time at which the subscription change is to happen or has happened. **Note:**\nIt is recommended not to pass this parameter along with `reactivate_from`.\n`changes_scheduled_at`\ncan 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\n* Only the following changes can be backdated:\n\n* Changes in the recurring items or their prices.\n\n* Addition of non-recurring items.\n\n* Subscription `status` is `active`, `cancelled`, or `non_renewing`.\n\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\n* The date is on or after `current_term_start`.\n\n* The date is on or after the last date/time any of the following changes were made:\n\n* Changes in the recurring items or their prices.\n\n* Addition of non-recurring items.\n\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\n**Note:**\nThe `changes_scheduled_at`\nparameter does not apply to `auto_collection`\n, `shipping_address`\n, and `po_number`\n; these parameters take effect **immediately**\nwhen scheduling a subscription update.\n",
                    "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.\n\n* end_of_term - The change is carried out at the end of the current billing cycle of the subscription.\n* specific_date -\n  The change is carried out as of the date specified under `changes_scheduled_at`\n  .\n* immediately - The change is carried out 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`\nor a custom value depending on the [site configuration](https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms)\n.\n",
                    "maximum" : 100,
                    "minimum" : 1,
                    "example" : null
                  },
                  "free_period" : {
                    "type" : "integer",
                    "format" : "int32",
                    "deprecated" : false,
                    "description" : "The period of time by which the first term of the subscription is to be extended free-of-charge. The value must be in multiples of free_period_unit.\n",
                    "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)\nattribute of the [plan](/docs/api/v2/pcv-1/subscriptions/create-a-subscription#plan_id)\nchosen.\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
                  },
                  "trial_end_action" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Applicable only when [End-of-trial Action](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)\nhas 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.\n\n* activate_subscription - The subscription activates and charges are raised for non-metered items.\n* cancel_subscription - The subscription cancels.\n* plan_default -\n  The action [configured for the site](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)\n  at the time when the trial ends, takes effect.\n* site_default -\n  This is the default value. The action [configured for the site](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)\n  at the time when the trial ends, takes effect.\n",
                    "enum" : [ "site_default", "plan_default", "activate_subscription", "cancel_subscription" ],
                    "example" : null
                  },
                  "card" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for card\n",
                    "properties" : {
                      "gateway_account_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The gateway account in which this payment source is stored.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Cardholder's first name\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Cardholder's last name\n",
                        "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)\n, 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.\n",
                        "maximum" : 12,
                        "minimum" : 1,
                        "example" : null
                      },
                      "expiry_year" : {
                        "type" : "integer",
                        "format" : "int32",
                        "deprecated" : false,
                        "description" : "Card expiry year.\n",
                        "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)\n, you can specify the Braintree encrypted CVV here.\n",
                        "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.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "billing_addr2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2, as available in card billing address.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "billing_city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "City, as available in card billing address.\n",
                        "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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `billing_state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "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`\nis provided.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "billing_zip" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Postal or Zip code, as available in card billing address.\n",
                        "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).\n\n  * `payer`: User related information.\n    * `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).\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n    * `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.\n* `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.\n\n  * `fraud`: Fraud identification related information.\n    * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n* `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.\n\n  * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.\n* `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.\n\n  * `payer`: User related information.\n    * `document`: Document is the user's identification number based on their country.\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "payment_method" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for payment_method\n",
                    "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)\nAPI 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.\n",
                        "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* .\nFor 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:**\nThis is not the one-time temporary token provided by gateways like Stripe.\n\nFor more details refer [Update payment method for a customer](/docs/api/customers/update-payment-method-for-a-customer)\nAPI under Customer resource.\n",
                        "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.\n",
                        "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)\n.\n\n**Note**:\nIf you enter an invalid country code, the system will return an error.\n\nIf you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\nin 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\nthe Brexit configuration, then `XI`\n(the code for **United Kingdom - Northern Ireland**\n) 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).\n\n  * `payer`: User related information.\n    * `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).\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n    * `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.\n* `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.\n\n  * `fraud`: Fraud identification related information.\n    * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n* `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.\n\n  * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.\n* `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.\n\n  * `payer`: User related information.\n    * `document`: Document is the user's identification number based on their country.\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "payment_intent" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for payment_intent\n",
                    "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.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "gateway_account_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The gateway account used for performing the 3DS flow.\n",
                        "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)\nto find out the gateway-specific gw_token format. Applicable when you are using gateway APIs directly for completing the 3DS flow.\n",
                        "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.\n\n* card - card\n* twint - Payments made via Twint\n* dotpay - dotpay\n* 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 -\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 -\n* alipay - Payments made via Alipay.\n* tamara - Payments made via Tamara.\n* pay_to -\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.\n",
                        "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).\n\n  * `payer`: User related information.\n    * `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).\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n    * `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.\n* `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.\n\n  * `fraud`: Fraud identification related information.\n    * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n* `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.\n\n  * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.\n* `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.\n\n  * `payer`: User related information.\n    * `document`: Document is the user's identification number based on their country.\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "billing_address" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for billing_address\n",
                    "properties" : {
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The first name of the billing contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The last name of the billing contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "The email address.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "company" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The company name.\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The phone number.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line3" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 3\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "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`\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.\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.  \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.\n\n* valid - Address was validated successfully.\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n",
                        "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "shipping_address" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for shipping_address\n",
                    "properties" : {
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The first name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The last name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "The email address.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "company" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The company name.\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The phone number.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line3" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 3\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "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`\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.\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://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.\n\n* not_validated - Address is not yet validated.\n* valid - Address was validated successfully.\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n",
                        "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "statement_descriptor" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for statement_descriptor\n",
                    "properties" : {
                      "descriptor" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Payment transaction descriptor text to help your customer easily recognize the transaction. When this value is passed this will override the [transaction descriptor](https://www.chargebee.com/docs/1.0/transaction_descriptors.html)\ntext configured in the Chargebee site for all the subscription renewal transactions.\n",
                        "maxLength" : 65000,
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "customer" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for customer\n",
                    "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)\n\n`country`\nas\n`XI`\n(which is **United Kingdom - Northern Ireland**\n), the first two characters of the [full VAT number](https://en.wikipedia.org/wiki/VAT_identification_number)\ncan be overridden by setting\n[vat_number_prefix](/docs/api/customers/customer-object#vat_number_prefix)\n.\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).\nOnly applicable specifically for customers with [billing_address](/docs/api/customers/customer-object#billing_address)\n\n`country`\nas `XI`\n(which is **United Kingdom - Northern Ireland**\n).\n\nWhen you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\nin 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\nthe Brexit configuration, you have the option of setting [billing_address](/docs/api/customers/customer-object#billing_address)\n\n`country`\nas `XI`.\nThat's the code for **United Kingdom - Northern Ireland** .\nThe first two characters of the VAT number in such a case is\n`XI`\nby default. However, if the VAT number was registered in UK, the value should be `GB`.\nSet\n`vat_number_prefix`\nto `GB`\nfor such cases.\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)\nof 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.\n\n* automatic - Use this value to send e-invoice every time an invoice or credit note is created.\n* manual - When manual is selected the automatic e-invoice sending is disabled. Use this value to send e-invoice manually through UI or API.\n* site_default - The default value of the site which can be overridden at the customer level.\n",
                        "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`.\nCurrently 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.\n",
                        "example" : null
                      },
                      "registered_for_gst" : {
                        "type" : "boolean",
                        "deprecated" : false,
                        "description" : "Confirms that a customer is registered under GST. If set to `true`\nthen the [Reverse Charge Mechanism](https://www.chargebee.com/docs/australian-gst.html#reverse-charge-mechanism)\nis applicable. This field is applicable only when Australian GST is configured for your site.\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "contract_term" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for contract_term\n",
                    "properties" : {
                      "action_at_term_end" : {
                        "type" : "string",
                        "default" : "renew",
                        "deprecated" : false,
                        "description" : "Action to be taken when the contract term completes.\n\n* renew_once -\n  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).\n\n  * The `action_at_term_end` for the new contract term is set to `cancel`.\n* cancel - Contract term completes and subscription is canceled.\n* evergreen - Contract term completes and the subscription renews.\n* renew -\n  * 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).\n  * The `action_at_term_end` for the new contract term is set to `renew`.\n",
                        "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)\n, 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.\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "Identifier of the addon. Multiple addons can be passed.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "default" : 1,
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price" : {
                        "type" : "array",
                        "description" : "Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started).\nThe Plan's billing frequency will not be considered for overriding. E.g. If the Plan's billing frequency is every 3 months, and if the price override amount is $10, $10 will be used, and not $30 (i.e $10 x 3). If `changes_scheduled_at`\nis in the past and `addons[unit_price][i]`\nis not passed, then the addon's current unit price is considered even if the addon did not exist on the date as of when the change is scheduled.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "billing_cycles" : {
                        "type" : "array",
                        "description" : "Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_in_decimal" : {
                        "type" : "array",
                        "description" : "The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 33,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price_in_decimal" : {
                        "type" : "array",
                        "description" : "When [price overriding](https://www.chargebee.com/docs/price-override.html)\nis enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)\nis used by default. However, the price provided here is considered as the price of the addon for an entire billing cycle of the subscription regardless of the value of the addon period. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/getting-started)\nis enabled. If `changes_scheduled_at`\nis in the past and `addons[unit_price_in_decimal][i]`\nis not passed, then the addon's current unit price is considered even if the addon did not exist on the date as of when the change is scheduled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      },
                      "trial_end" : {
                        "type" : "array",
                        "description" : "The time at which the trial ends for the addon. To update this value, redo the complete addon set using [`replace_addon_list`](/docs/api/v2/pcv-1/subscriptions/update-a-subscription#replace_addon_list).\n(Addon trial periods must be enabled by [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",
                        "items" : {
                          "type" : "integer",
                          "format" : "unix-time",
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      },
                      "proration_type" : {
                        "type" : "array",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "description" : "Specifies how to manage charges or credits for the addon during this subscription update. It's relevant only for addons that have their [pricing_model](/docs/api/v2/pcv-1/addons/addon-object#pricing_model)\nset to `per_unit`.\nYou may use this parameter only if the change to the subscription takes effect [immediately](/docs/api/v2/pcv-1/subscriptions/update-a-subscription#change_option).  \n**Note**\n\n* Once set, this parameter becomes a [subscription attribute](/docs/api/v2/pcv-1/subscriptions/subscription-object#addons_proration_type) and automatically applies to any additional changes to the addon during the current term. It's removed from the subscription attributes at renewal. You can't alter this parameter's value within the current term via later API calls.\n* If you don't provide a value, Chargebee determines the proration logic based on the following precedence: this parameter \\> [prorate](/docs/api/v2/pcv-1/subscriptions/update-a-subscription#prorate) parameter \\> [addon.proration_type](/docs/api/v2/pcv-1/addons/addon-object#proration_type) \\> [site-wide proration](https://www.chargebee.com/docs/1.0/proration.html#proration-for-subscription-change) setting.\n\n* partial_term - Prorate the charges or credits for the rest of the current term.\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",
                          "enum" : [ "full_term", "partial_term", "none" ],
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "event_based_addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for event_based_addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "A unique 'id' used to identify the addon.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price" : {
                        "type" : "array",
                        "description" : "Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "service_period_in_days" : {
                        "type" : "array",
                        "description" : "Defines service period of the addon in days from the day of charge.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "maximum" : 4000,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "charge_on" : {
                        "type" : "array",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "description" : "Indicates when the non-recurring addon will be charged.\n\n* immediately - Charges for the addon will be applied immediately.\n* on_event - Charge for the addon will be applied on the occurrence of a specified event.\n",
                          "enum" : [ "immediately", "on_event" ],
                          "example" : null
                        },
                        "example" : null
                      },
                      "on_event" : {
                        "type" : "array",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "description" : "Event on which this addon will be charged.\n\n* subscription_creation - Addon will be charged on subscription creation.\n* subscription_trial_start - Addon will be charged when the trial period starts.\n* plan_activation - Addon will be charged on plan activation.\n* contract_termination - Addon will be charged on contract termination.\n* subscription_activation - Addon will be charged on subscription activation.\n",
                          "enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ],
                          "example" : null
                        },
                        "example" : null
                      },
                      "charge_once" : {
                        "type" : "array",
                        "description" : "If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.\n",
                        "items" : {
                          "type" : "boolean",
                          "default" : true,
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_in_decimal" : {
                        "type" : "array",
                        "description" : "The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 33,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price_in_decimal" : {
                        "type" : "array",
                        "description" : "When [price overriding](http://chargebee.com/docs/price-override.html )\nis enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)\nis used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  }
                },
                "example" : null
              },
              "encoding" : {
                "addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "billing_address" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "card" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "contract_term" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "customer" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "event_based_addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "payment_intent" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "payment_method" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "shipping_address" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "statement_descriptor" : {
                  "style" : "deepObject",
                  "explode" : true
                }
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "subscription" : {
                      "$ref" : "#/components/schemas/Subscription",
                      "description" : "Resource object representing subscription\n"
                    },
                    "customer" : {
                      "$ref" : "#/components/schemas/Customer",
                      "description" : "Resource object representing customer\n"
                    },
                    "card" : {
                      "$ref" : "#/components/schemas/Card",
                      "description" : "Resource object representing card\n"
                    },
                    "invoice" : {
                      "$ref" : "#/components/schemas/Invoice",
                      "description" : "Resource object representing invoice\n"
                    },
                    "unbilled_charges" : {
                      "type" : "array",
                      "description" : "Resource object representing unbilled_charge\n",
                      "items" : {
                        "$ref" : "#/components/schemas/UnbilledCharge",
                        "description" : "Resource object representing unbilled_charge"
                      },
                      "example" : null
                    },
                    "credit_notes" : {
                      "type" : "array",
                      "description" : "Resource object representing credit_note\n",
                      "items" : {
                        "$ref" : "#/components/schemas/CreditNote",
                        "description" : "Resource object representing credit_note"
                      },
                      "example" : null
                    }
                  },
                  "required" : [ "customer", "subscription" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/subscriptions/{subscription-id}/import_contract_term" : {
      "post" : {
        "tags" : [ "subscriptions" ],
        "summary" : "Import contract term",
        "description" : "Import previous and active [contract terms](/docs/api/contract_terms)\n.\n\nFor contract terms in `active`\nstate, import is allowed only if the associated subscription is `active`\n, `in_trial`\n, `future`\nor `non-renewing`\n.\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" : "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" : "Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as `billing_cycles`\nor a custom value depending on the [site configuration](https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms)\n.\n",
                    "maximum" : 100,
                    "minimum" : 1,
                    "example" : null
                  },
                  "contract_term" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for contract_term\n",
                    "properties" : {
                      "id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Id that uniquely identifies the contract term in the site.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "created_at" : {
                        "type" : "integer",
                        "format" : "unix-time",
                        "deprecated" : false,
                        "description" : "The date when the contract term was created.\n",
                        "example" : null
                      },
                      "contract_start" : {
                        "type" : "integer",
                        "format" : "unix-time",
                        "deprecated" : false,
                        "description" : "The start date of the contract term\n",
                        "example" : null
                      },
                      "contract_end" : {
                        "type" : "integer",
                        "format" : "unix-time",
                        "deprecated" : false,
                        "description" : "The end date of the contract term\n",
                        "example" : null
                      },
                      "status" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Current status of contract\n\n* active - An actively running contract term.\n* completed - The contract term has run its full duration.\n* cancelled -\n  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).\n\n  * the subscription was cancelled 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 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)\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 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)\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/invoice-object#total)\nof all the invoices raised as part of the contract term. For `active`\ncontract terms, this is a predicted value. The value depends on the [type of currency](/docs/api/v2/pcv-1/subscriptions).\nIf the subscription was [imported](/docs/api/v2/pcv-1/subscriptions/import-a-subscription)\nwith the contract term, then this value includes the value passed for `total_amount_raised`\n.\n",
                        "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`\nis included in the calculation of the total contract value before tax. It's important to note that this value excludes any applicable taxes.\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 is for.\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.\n\n* evergreen - Contract term completes and the subscription renews.\n* renew_once -\n  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).\n\n  * The `action_at_term_end` for the new contract term is set to `cancel`.\n* cancel - Contract term completes and subscription is canceled.\n* renew -\n  * 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).\n  * The `action_at_term_end` for the new contract term is set to `renew`.\n",
                        "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)\n, 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.\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\n"
                    }
                  },
                  "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" : "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.\n",
                    "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.\n\n* off - Automatic collection of charges will not be made for this subscription. Use this for offline payments.\n* on - Whenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.\n",
                    "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\n"
                    },
                    "payment_source" : {
                      "$ref" : "#/components/schemas/PaymentSource",
                      "description" : "Resource object representing payment_source\n"
                    }
                  },
                  "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",
        "operationId" : "remove_scheduled_pause",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "subscription-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/subscription-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "subscription" : {
                      "$ref" : "#/components/schemas/Subscription",
                      "description" : "Resource object representing subscription\n"
                    },
                    "customer" : {
                      "$ref" : "#/components/schemas/Customer",
                      "description" : "Resource object representing customer\n"
                    },
                    "card" : {
                      "$ref" : "#/components/schemas/Card",
                      "description" : "Resource object representing card\n"
                    }
                  },
                  "required" : [ "customer", "subscription" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/subscriptions/{subscription-id}/cancel" : {
      "post" : {
        "tags" : [ "subscriptions" ],
        "summary" : "Cancel a subscription",
        "description" : "Cancelling a subscription will move the subscription from its current state to **Cancelled**, and will stop all recurring actions.\n\nYou could schedule the cancellation by passing **end_of_term** parameter as **true** . If scheduled, the subscription status will be set to **non_renewing** if it is in **active** state, until the end of term, and then **cancelled** . A subscription's state will not change if it is in **in_trial** state. However, cancellation will be scheduled at the end of the trial.\n\n#### CREDIT OPTION\n\nOn subscription cancellation, credits can be issued against current term charges of the subscription by using **credit_option_for_current_term_charges**. You can choose to either provide no credits, prorate credits for the unused period or issue full credits for the current term charges.\n\n#### UNBILLED CHARGES\n\nAny unbilled charges present in the subscription can either be invoiced or deleted by specifying **unbilled_charges_option**. Note that automatic charge will be attempted on the payment method available if the customer has enabled auto-collection. If not, the invoice will be closed as unpaid.\n\n#### ACCOUNT RECEIVABLES\n\nSpecifying **account_receivables_handling** allows you to close invoices of the subscription which have amounts due. The invoices are chosen for payment collection or for writing off the due amount after applying the available credits and excess payments.\n\nIf specified as **schedule_payment_collection** , payment collection for the amount due of past invoices will be attempted. The payment method available will be charged if auto-collection is enabled for the customer, and appropriate payment collection(payment succeeded or payment failed) events will be triggered. If the payment collection fails, no further retries will be made on the invoices. **Note:** If the invoices of the subscription are consolidated, and any of the subscriptions in the consolidated invoice are cancelled, these invoices will not be selected for collection.\n\nIf specified as **write_off** , the amount due of past invoices will be written-off. **Note:** If the invoices of the subscription are consolidated, and any of the subscriptions in the consolidated invoice are still active(future, in-trial, active, and non-renewing), these invoices will not be selected for the write-off operation.\n\n#### ACCOUNT PAYABLES\n\nSpecifying refundable_credits_handling allows you to provide refunds for refundable credits remaining, after they are applied to a subscription's due invoices. The refund initiated will be asynchronous and the payment refunded event will be triggered on refund success. **Note:** Consolidated credit notes of the subscription will not be selected for refund.\n\n#### Contract terms\n\nIf the subscription has [contract terms](/docs/api/contract_terms), it can only be canceled by terminating the contract using the `contract_term_cancel_option`. The contract term and the subscription are canceled together.\n\n##### Contract terms parameters\n\n* [contract_term_cancel_option](/docs/api/v2/pcv-1/subscriptions/cancel-a-subscription#contract_term_cancel_option)\n* [cancel_at](/docs/api/v2/pcv-1/subscriptions/cancel-a-subscription#cancel_at)\n* [credit_option_for_current_term_charges](/docs/api/v2/pcv-1/subscriptions/cancel-a-subscription#credit_option_for_current_term_charges)\n* [unbilled_charges_option](/docs/api/v2/pcv-1/subscriptions/cancel-a-subscription#unbilled_charges_option)\n* [account_receivables_handling](/docs/api/v2/pcv-1/subscriptions/cancel-a-subscription#account_receivables_handling)\n* [refundable_credits_handling](/docs/api/v2/pcv-1/subscriptions/cancel-a-subscription#refundable_credits_handling)\n\nAdvance charges, if any, will be refunded as credits.\n",
        "operationId" : "cancel_a_subscription",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "subscription-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/subscription-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "cancel_option" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "##### If the subscription does not have a contract term:\n\nDetermines when to cancel the subscription.\n\n##### If the subscription has a contract term:\n\nThis parameter is not applicable.\n\n* 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\n* end_of_term - This is used to cancel a subscription at the end of the current billing cycle\n* immediately - This is used to cancel the subscription with immediate effect\n* 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`\n",
                    "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.\nApplicable only when the subscription does not have [contract terms](/docs/api/contract_terms).\nSet 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`.\n",
                    "example" : null
                  },
                  "cancel_at" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "##### If the subscription does not have a contract term:\n\nSpecifies the date and time when the subscription should be canceled. Do not use this parameter when `end_of_term` is set to `true`.\n\n##### If the subscription has a contract term:\n\nApplicable only when `contract_term_cancel_option` is `specific_date`. Specifies the date and time to cancel the subscription and contract term.\n\n##### Backdating\n\nYou can set a past date to backdate the cancellation. Backdating is allowed only if the following conditions are met:\n\n* [Backdating](https://www.chargebee.com/docs/1.0/backdating.html) is enabled for subscription cancellation.\n* The current date does not exceed the [backdating limit configured in Chargebee Billing](https://www.chargebee.com/docs/1.0/backdating.html#configuring-backdated-subscription-actions-and-invoicing).\n* The date is on or after the `current_term_start`.\n* The date is on or after the most recent change involving:\n  * Addition/change/removal of plan or addon item prices.\n  * Addition of charge item prices.\n* 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.\n",
                    "example" : null
                  },
                  "credit_option_for_current_term_charges" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "##### If the subscription does not have a contract term:\n\nSpecifies 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/1.0/cancellations.html#configure-subscription-cancellation) is used.\n\n##### If the subscription has a contract term:\n\nSpecifies 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/1.0/contract-terms.html#configuring-contract-terms) is used.\n\n* none - No credits notes are created.\n* full - Credits are issues for the full value of the current term charges.\n* prorate - Prorated credits are issued.\n",
                    "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:\n\nSpecifies 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/1.0/cancellations.html#configure-subscription-cancellation) is used.\n\n##### If the subscription has a contract term:\n\nSpecifies 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/1.0/contract-terms.html#configuring-contract-terms) is used.\n\n* invoice - An invoice is generated immediately with the unbilled charges.\n* delete - The unbilled charges are deleted.\n",
                    "enum" : [ "invoice", "delete" ],
                    "example" : null
                  },
                  "account_receivables_handling" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "##### If the subscription does not have a contract term:\n\nSpecifies 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/1.0/cancellations.html#configure-subscription-cancellation) is used.\n\n##### If the subscription has a contract term:\n\nSpecifies 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/1.0/contract-terms.html#configuring-contract-terms) is used.\n\n* no_action - No action is taken.\n* write_off -\n  Applies excess payments and refundable credits to past due invoices. Any remaining balance is written off.\n\n  *Note: The credit note for the write-off is not included in the API response.*\n* schedule_payment_collection -\n  Applies excess payments and refundable credits to past due invoices. If any amount remains and `auto_collection`\n  is `on`\n  , the remaining amount is automatically charged to the available payment method.\n",
                    "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:\n\nSpecifies 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/1.0/cancellations.html#configure-subscription-cancellation) is used.\n\n##### If the subscription has a contract term:\n\nSpecifies 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/1.0/contract-terms.html#configuring-contract-terms) is used.\n\n* schedule_refund - Refunds remaining credits after applying them to any past due invoices.\n* no_action - No action is taken.\n",
                    "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.\n\n* terminate_immediately -\n  Cancels the subscription and contract term immediately. Sets the contract term's `status` to `terminated` and collects any termination fee, if applicable.\n\n  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).\n* end_of_contract_term - Prevents the contract term from renewing and schedules the subscription for cancellation at the end of the contract term.\n* specific_date -\n  Cancels the subscription and contract term on the date specified by `cancel_at`. Sets `action_at_term_end` to `cancel`.\n\n  **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/1.0/sites-intro.html).\n* end_of_subscription_billing_term -\n  Cancels the subscription and contract term at the end of the current billing cycle. Sets `action_at_term_end` to `cancel`.\n\n  **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/1.0/sites-intro.html).\n",
                    "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`\nis `true`\n, 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`\nand `line_item_taxes`\nare computed based on the `tax`\nconfiguration as of `invoice_date`.\nWhen passing this parameter, the following prerequisites must be met:\n\n* `invoice_date` must be in the past.\n* `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.\n* It is not earlier than `cancel_at`. .\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**.\nMust be passed if set as mandatory in the app. The codes are case-sensitive.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "event_based_addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for event_based_addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "The unique `id`\nof the event-based addon that represents the termination fee.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "The quantity associated with the termination fee. Applicable only when the addon for the termination charge is quantity-based.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price" : {
                        "type" : "array",
                        "description" : "The termination fee. In case it is quantity-based, this is the fee per unit.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "service_period_in_days" : {
                        "type" : "array",
                        "description" : "The service period of the termination fee-expressed in days-starting from the current date.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "maximum" : 4000,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  }
                },
                "example" : null
              },
              "encoding" : {
                "event_based_addons" : {
                  "style" : "deepObject",
                  "explode" : true
                }
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "subscription" : {
                      "$ref" : "#/components/schemas/Subscription",
                      "description" : "Resource object representing subscription\n"
                    },
                    "customer" : {
                      "$ref" : "#/components/schemas/Customer",
                      "description" : "Resource object representing customer\n"
                    },
                    "card" : {
                      "$ref" : "#/components/schemas/Card",
                      "description" : "Resource object representing card\n"
                    },
                    "invoice" : {
                      "$ref" : "#/components/schemas/Invoice",
                      "description" : "Resource object representing invoice\n"
                    },
                    "unbilled_charges" : {
                      "type" : "array",
                      "description" : "Resource object representing unbilled_charge\n",
                      "items" : {
                        "$ref" : "#/components/schemas/UnbilledCharge",
                        "description" : "Resource object representing unbilled_charge"
                      },
                      "example" : null
                    },
                    "credit_notes" : {
                      "type" : "array",
                      "description" : "Resource object representing credit_note\n",
                      "items" : {
                        "$ref" : "#/components/schemas/CreditNote",
                        "description" : "Resource object representing credit_note"
                      },
                      "example" : null
                    }
                  },
                  "required" : [ "customer", "subscription" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/subscriptions/{subscription-id}/charge_addon_at_term_end" : {
      "post" : {
        "tags" : [ "subscriptions" ],
        "summary" : "Charge addon at term end",
        "description" : "Adds a \"non-recurring addon\" charge to a subscription which will be added to the invoice generated at the end of the current term. If there are any applicable coupons in the subscription, an appropriate discount will be applied.\n\nTo collect the charges for the non-recurring addon immediately, [use this API](/docs/api/v2/pcv-1/invoices/create-invoice-for-a-non-recurring-addon).  \nIf any subscription changes happen before the end of the current term, these charges will be collected along with it.\n",
        "operationId" : "charge_addon_at_term_end",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "subscription-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/subscription-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "addon_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The ID of the non-recurring addon to be charged.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "addon_quantity" : {
                    "type" : "integer",
                    "format" : "int32",
                    "deprecated" : false,
                    "description" : "The number of addon units to be charged. Mandatory for quantity based addons.\n",
                    "minimum" : 1,
                    "example" : null
                  },
                  "addon_unit_price" : {
                    "type" : "integer",
                    "format" : "int64",
                    "deprecated" : false,
                    "description" : "Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                    "minimum" : 0,
                    "example" : null
                  },
                  "addon_quantity_in_decimal" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The decimal representation of the quantity of the [non-recurring addon](https://www.chargebee.com/docs/charges.html#non-recurring-addon ).\nProvide the value in major units of the currency. Must be provided when the addon is quantity-based. This parameter can only be passed when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                    "maxLength" : 33,
                    "example" : null
                  },
                  "addon_unit_price_in_decimal" : {
                    "type" : "string",
                    "default" : "Addon Amount in Decimal",
                    "deprecated" : false,
                    "description" : "When [price overriding](http://chargebee.com/docs/price-override.html )\nis enabled for the site, the price or per-unit price of [the non-recurring addon](https://www.chargebee.com/docs/charges.html#non-recurring-addon )\ncan be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)\nis used by default. Provide the value as a decimal string in major units of the currency. This parameter can only be passed when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                    "maxLength" : 39,
                    "example" : null
                  },
                  "date_from" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "The time when the service period for the addon starts.\n",
                    "example" : null
                  },
                  "date_to" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "The time when the service period for the addon ends.\n",
                    "example" : null
                  }
                },
                "required" : [ "addon_id" ],
                "example" : null
              },
              "encoding" : { }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "estimate" : {
                      "$ref" : "#/components/schemas/Estimate",
                      "description" : "Resource object representing estimate\n"
                    }
                  },
                  "required" : [ "estimate" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/subscriptions/{subscription-id}/edit_advance_invoice_schedule" : {
      "post" : {
        "tags" : [ "subscriptions" ],
        "summary" : "Edit advance invoice schedule",
        "description" : "Modifies the [advance invoicing schedule](/docs/api/advance_invoice_schedules) for a subscription.\n",
        "operationId" : "edit_advance_invoice_schedule",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "subscription-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/subscription-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "terms_to_charge" : {
                    "type" : "integer",
                    "format" : "int32",
                    "deprecated" : false,
                    "description" : "The number of billing cycles in one interval.\n",
                    "minimum" : 1,
                    "example" : null
                  },
                  "schedule_type" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The type of advance invoice or advance invoicing schedule.\n\n* specific_dates -\n  Charge on [specific dates](/docs/api/subscriptions/charge-future-renewals#specific_dates_schedule_date).\n  For each date, specify the [number of billing cycles](/docs/api/subscriptions/charge-future-renewals#specific_dates_schedule_terms_to_charge)\n  to charge for. Up to 5 dates can be configured.\n* fixed_intervals -\n  Charge at fixed intervals of time. Specify the [number of billing cycles](/docs/api/subscriptions/charge-future-renewals#terms_to_charge)\n  that constitute an interval and the number of [days before each interval](/docs/api/subscriptions/charge-future-renewals#fixed_interval_schedule_days_before_renewal)\n  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)\n  .\n",
                    "enum" : [ "specific_dates", "fixed_intervals" ],
                    "example" : null
                  },
                  "fixed_interval_schedule" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for fixed_interval_schedule\n",
                    "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)\nof 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)\n= `after_number_of_intervals`\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",
                        "minimum" : 1,
                        "example" : null
                      },
                      "end_schedule_on" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Specifies when the schedule should end.\n\n* after_number_of_intervals - Advance invoices are generated a `specified number of times`\n* subscription_end - Advance invoices are generated for as long as the subscription is active.\n* specific_date -\n  End the advance invoicing schedule on a `specific date`\n  .\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 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)\n= `specific_date`\n.\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "specific_dates_schedule" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for specific_dates_schedule\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "The [unique id](/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#id)\nof the member of the [advance_invoice_schedule](/docs/api/advance_invoice_schedules)\narray which corresponds to the [specific_dates_schedule](/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#specific_dates_schedule)\nthat you intend to modify. Only applicable when [schedule_type](/docs/api/subscriptions/edit-advance-invoice-schedule#schedule_type)\nis specific_dates.\n",
                        "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)\nis specific_dates.\n",
                        "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)\nis `specific_dates`\n.\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" : {
                    "advance_invoice_schedules" : {
                      "type" : "array",
                      "description" : "Resource object representing advance_invoice_schedule\n",
                      "items" : {
                        "$ref" : "#/components/schemas/AdvanceInvoiceSchedule",
                        "description" : "Resource object representing advance_invoice_schedule"
                      },
                      "example" : null
                    }
                  },
                  "required" : [ "advance_invoice_schedules" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/subscriptions/{subscription-id}/contract_terms" : {
      "get" : {
        "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",
        "operationId" : "list_contract_terms_for_a_subscription",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "subscription-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/subscription-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        }, {
          "name" : "limit",
          "in" : "query",
          "description" : "The number of resources to be returned.\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`\nto the value of `next_offset`\nobtained in the previous iteration of the API call.\n",
          "required" : false,
          "deprecated" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "maxLength" : 1000,
            "example" : null
          }
        }, {
          "name" : "sort_by",
          "in" : "query",
          "description" : "optional, string filter\n\nSorts based on the specified attribute.\n**Supported attributes :**\ncreated_at\n\n**Supported sort-orders :**\nasc, desc\n\n**Example →**\n*sort_by\\[asc\\] = \"created_at\"*\n\nThis will sort the result based on the 'created_at' attribute in ascending (earliest first) order.\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" : {
                          "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`.\n",
                      "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" : "Pauses the subscription, changing its `status` to `paused`. This prevents the subscription from getting renewed. No new charges are created until the subscription is resumed.\n\n#### Note:\n\n* Applicable only for **active/non-renewing** subscriptions.\n* If paused indefinitely, the subscription is cancelled on the [cancelled_at](/docs/api/subscriptions/subscription-object#cancelled_at) date.\n* Advance charges, if any, are refunded as credits.\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" : "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.\n\n* 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\n* immediately - Pause immediately\n* end_of_term - Pause at the end of current term\n* specific_date - Pause on a specific date\n",
                    "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.\nFor non-renewing subscriptions, `pause_date` should be before the cancellation date.\n",
                    "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`.\n\n* invoice -\n  Invoice charges\n  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.\n* no_action -\n  Retain as unbilled\n  If `no_action` is chosen, charges are added to the resumption invoice.\n",
                    "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`.\nIf invoice is in the dunning cycle, `invoice_dunning_handing` allows you to `stop` or `continue` dunning.\n\n* continue - Continue dunning\n* stop - Stop dunning\n",
                    "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)\nis `billing_cycles`\n.\n",
                    "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.\nFor non-renewing subscriptions,`resume_date` should be before the cancellation date.\n",
                    "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\n"
                    },
                    "customer" : {
                      "$ref" : "#/components/schemas/Customer",
                      "description" : "Resource object representing customer\n"
                    },
                    "card" : {
                      "$ref" : "#/components/schemas/Card",
                      "description" : "Resource object representing card\n"
                    },
                    "invoice" : {
                      "$ref" : "#/components/schemas/Invoice",
                      "description" : "Resource object representing invoice\n"
                    },
                    "unbilled_charges" : {
                      "type" : "array",
                      "description" : "Resource object representing unbilled_charge\n",
                      "items" : {
                        "$ref" : "#/components/schemas/UnbilledCharge",
                        "description" : "Resource object representing unbilled_charge"
                      },
                      "example" : null
                    },
                    "credit_notes" : {
                      "type" : "array",
                      "description" : "Resource object representing credit_note\n",
                      "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" : "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" : "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 particular customer identified by the a unique identifier.  \nThis will delete the Payment Method from the gateway/vault. If you do not want the Payment Method to be deleted from the vault, set the value for the delete_payment_method parameter to false.\nThis operation is irreversible - all data related to the customer, such as subscriptions, invoices, transactions, and reports, will be deleted.\n**Note:** This operation schedules the customer resource for deletion. It will be deleted in a few minutes.\n",
        "operationId" : "delete_a_customer",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "customer-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/customer-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "delete_payment_method" : {
                    "type" : "boolean",
                    "default" : true,
                    "deprecated" : false,
                    "description" : "Deletes the Payment Method from the gateway/vault.\n",
                    "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\n"
                    },
                    "card" : {
                      "$ref" : "#/components/schemas/Card",
                      "description" : "Resource object representing card\n"
                    }
                  },
                  "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" : "Establish a [hierarchical relationship](https://www.chargebee.com/docs/1.0/account-hierarchy.html) between customers. The path parameter `customer_id` identifies the child in this relationship.  \n**Prerequisite**\nBoth parent and child customers must be part of the same [business entity](/docs/api/v2/pcv-1/advanced-features).  \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**Note**\nFor the `use_default_hierarchy_settings`, `parent_account_access`, and `child_account_access` parameters below, the term \"parent\" usually refers to the customer with the ID [payment_owner_id](/docs/api/v2/pcv-1/customers/link-a-customer#payment_owner_id). However, if the `payment_owner_id` is the same as the child's ID (`{customer_id}`), the \"parent\" is identified by [parent_id](/docs/api/v2/pcv-1/customers/link-a-customer#parent_id).\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" : "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`\n.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "payment_owner_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The `id`\nof the customer responsible for paying the invoices for the customer identified by `customer_id`.\nThis ID must match either `customer_id`\nor `invoice_owner_id`\n.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "invoice_owner_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The `id`\nof the customer who receives the invoice for charges incurred by the customer identified by `customer_id`.\nThis ID must match either `customer_id`\nor 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/1.0/account-hierarchy.html#advanced-mode) or from this API request.\n\n* If set to `true`: Chargebee uses settings configured in the Chargebee Billing UI.\n* If set to `false`: Settings provided in the `parent_account_access` and `child_account_access` parameters are applied.\n",
                    "example" : null
                  },
                  "parent_account_access" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Settings for the parent account's access.\n",
                    "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.\n\n* yes - The parent can view and edit the child's subscriptions.\n* no - The parent can't view or edit the child's subscriptions.\n* view_only - The parent can only view the child's subscriptions.\n",
                        "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.\n\n* no - The parent can't view or download the child's invoices.\n* view_only - The parent can view but not download the child's invoices.\n* yes - The parent can both view and download the child's invoices.\n",
                        "enum" : [ "yes", "view_only", "no" ],
                        "example" : null
                      },
                      "send_subscription_emails" : {
                        "type" : "boolean",
                        "deprecated" : false,
                        "description" : "If set to `true`\n, the parent receives email notifications for the child's subscriptions.\n",
                        "example" : null
                      },
                      "send_payment_emails" : {
                        "type" : "boolean",
                        "deprecated" : false,
                        "description" : "If set to `true`\n, the parent receives email notifications for payment-related activities on the child's invoices.\n",
                        "example" : null
                      },
                      "send_invoice_emails" : {
                        "type" : "boolean",
                        "deprecated" : false,
                        "description" : "If set to `true`\n, the parent receives email notifications for the child's invoices.\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "child_account_access" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Settings for the child account's access.\n",
                    "properties" : {
                      "portal_edit_subscriptions" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Determines the child's access to its own subscriptions in the Self-Serve Portal.\n\n* view_only - The child account can only view its subscriptions.\n* yes - The child account can view and edit its subscriptions.\n",
                        "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.\n\n* yes - The child account can both view and download its invoices.\n* view_only - The child account can view but not download its invoices.\n* no - The child account cannot view or download its own invoices.\n",
                        "enum" : [ "yes", "view_only", "no" ],
                        "example" : null
                      },
                      "send_subscription_emails" : {
                        "type" : "boolean",
                        "deprecated" : false,
                        "description" : "If set to `true`\n, the child account receives email notifications for its subscriptions.\n",
                        "example" : null
                      },
                      "send_payment_emails" : {
                        "type" : "boolean",
                        "deprecated" : false,
                        "description" : "If set to `true`\n, the child account receives email notifications for payment-related activities for its invoices.\n",
                        "example" : null
                      },
                      "send_invoice_emails" : {
                        "type" : "boolean",
                        "deprecated" : false,
                        "description" : "If set to `true`\n, the child account receives email notifications for its invoices.\n",
                        "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\n"
                    }
                  },
                  "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/1.0/account-hierarchy.html)\n, this operation detaches the customer from its parent. The hierarchy, if any, beneath the customer remains unchanged.\n",
        "operationId" : "delink_a_customer",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "customer-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/customer-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "customer" : {
                      "$ref" : "#/components/schemas/Customer",
                      "description" : "Resource object representing customer\n"
                    }
                  },
                  "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.\n",
        "operationId" : "delete_contacts_for_a_customer",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "customer-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/customer-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "contact" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for contact\n",
                    "properties" : {
                      "id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Unique reference ID provided for the contact.\n",
                        "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\n"
                    },
                    "card" : {
                      "$ref" : "#/components/schemas/Card",
                      "description" : "Resource object representing card\n"
                    }
                  },
                  "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 Primary or Backup payment role or unassign role for the payment source based on the preference for the payment collection.\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" : "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.\n",
                    "maxLength" : 40,
                    "example" : null
                  },
                  "role" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Indicates whether the payment source is Primary, Backup, or neither.\n\n* backup - Backup\n* none - None\n* primary - Primary\n",
                    "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\n"
                    },
                    "payment_source" : {
                      "$ref" : "#/components/schemas/PaymentSource",
                      "description" : "Resource object representing payment_source\n"
                    }
                  },
                  "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
          }
        } ],
        "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.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "from_site" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Name of the site from which this customer need to be copied.\n",
                    "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\n"
                    }
                  },
                  "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/v2/pcv-1/hierarchies)\nfor a customer.\n",
        "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}`\n\n* complete_hierarchy - Retrieve all nodes in the account hierarchy.\n* subordinates -\n  Retrieve all nodes in the account hierarchy that start from the specified customer (identified by `{customer_id}`\n  ) and include its subordinates. In other words, get nodes in the account hierarchy tree where the root node is the specified customer.\n* path_to_root -\n  Retrieve nodes from the specified customer (identified by `{customer_id}`\n  ) to the root of its account hierarchy.\n",
          "required" : true,
          "deprecated" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "deprecated" : false,
            "enum" : [ "complete_hierarchy", "subordinates", "path_to_root" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "customer-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/customer-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "hierarchies" : {
                      "type" : "array",
                      "description" : "Resource object representing hierarchy\n",
                      "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/v2/pcv-1/payment_sources/create-using-gateway-temporary-token)\nAPI or [Create using permanent token](/docs/api/payment_sources/create-using-permanent-token)\nAPI 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)\nAPI 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" : "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\n",
                    "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)\nAPI 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.\n",
                        "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* .\nFor 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:**\nThis is not the one-time temporary token provided by gateways like Stripe.\n\nFor more details refer [Update payment method for a customer](/docs/api/customers/update-payment-method-for-a-customer)\nAPI under Customer resource.\n",
                        "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.\n",
                        "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)\n.\n\n**Note**:\nIf you enter an invalid country code, the system will return an error.\n\nIf you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\nin 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\nthe Brexit configuration, then `XI`\n(the code for **United Kingdom - Northern Ireland**\n) 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).\n\n  * `payer`: User related information.\n    * `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).\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n    * `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.\n* `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.\n\n  * `fraud`: Fraud identification related information.\n    * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n* `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.\n\n  * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.\n* `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.\n\n  * `payer`: User related information.\n    * `document`: Document is the user's identification number based on their country.\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device\n",
                        "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\n"
                    },
                    "card" : {
                      "$ref" : "#/components/schemas/Card",
                      "description" : "Resource object representing card\n"
                    }
                  },
                  "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.\n",
        "operationId" : "retrieve_a_customer",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "customer-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/customer-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "customer" : {
                      "$ref" : "#/components/schemas/Customer",
                      "description" : "Resource object representing customer\n"
                    },
                    "card" : {
                      "$ref" : "#/components/schemas/Card",
                      "description" : "Resource object representing card\n"
                    }
                  },
                  "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 customer resource. However, this method cannot be used for updating the 'Billing Info' - the Billing Address and 'vat_number' attributes - of the customer. To update the same, use our [Update Billing Info](/docs/api/customers/update-billing-info-for-a-customer) API.\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" : "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.\n",
                    "maxLength" : 150,
                    "example" : null
                  },
                  "last_name" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Last name of the customer.\n",
                    "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.\n",
                    "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.\n",
                    "maxLength" : 3,
                    "example" : null
                  },
                  "phone" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Phone number of the customer.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "company" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Company name of the customer.\n",
                    "maxLength" : 250,
                    "example" : null
                  },
                  "auto_collection" : {
                    "type" : "string",
                    "default" : "on",
                    "deprecated" : false,
                    "description" : "Whether payments needs to be collected automatically for this customer.\n\n* on - Whenever an invoice is created, an automatic attempt to charge the customer's payment method is made.\n* off - Automatic collection of charges will not be made. All payments must be recorded offline.\n",
                    "enum" : [ "on", "off" ],
                    "example" : null
                  },
                  "allow_direct_debit" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "Whether the customer can pay via Direct Debit.\n",
                    "example" : null
                  },
                  "net_term_days" : {
                    "type" : "integer",
                    "format" : "int32",
                    "default" : 0,
                    "deprecated" : false,
                    "description" : "The number of days within which the customer has to make payment for the invoice.\n",
                    "example" : null
                  },
                  "taxability" : {
                    "type" : "string",
                    "default" : "taxable",
                    "deprecated" : false,
                    "description" : "Specifies if the customer is liable for tax.\n\n* taxable -\n  Computes tax for the customer based on the [site configuration](https://www.chargebee.com/docs/tax.html).\n  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.\n* 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.\n* exempt -\n  * 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.\n  * 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.\n",
                    "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)\nintegration.\nTo 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/)\n.\n",
                    "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)\nintegration.\n\n* 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\n* industrial - When the purchase is made by an industrial business\n* business - When the purchase is made at a place of business\n* residential - When the purchase is made by a customer for home use\n",
                    "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)\nintegration.\n",
                    "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.\n\n* government - Government\n* other - Other\n* wholesale - Whole-sale\n",
                    "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.\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)\n.\n\n* med2 - US Medical Device Excise Tax with taxable sales tax\n* med1 - US Medical Device Excise Tax with exempt sales tax\n* d - Foreign diplomat\n* e - Charitable or benevolent organization\n* f - Religious organization\n* g - Resale\n* a - Federal government\n* b - State government\n* c - Tribe/Status Indian/Indian Band\n* l - Other or custom\n* m - Educational organization\n* n - Local government\n* h - Commercial agricultural production\n* i - Industrial production/manufacturer\n* j - Direct pay permit\n* k - Direct mail\n* p - Commercial aquaculture\n* q - Commercial Fishery\n* r - Non-resident\n",
                    "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)\n.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "offline_payment_method" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The preferred offline payment method for the customer.\n\n* custom - Custom\n* bank_transfer - Bank Transfer\n* boleto - Boleto\n* jp_automated_bank_transfer - JP Automated Bank Transfer\n* sepa_credit - SEPA Credit\n* cash - Cash\n* check - Check\n* mx_automated_bank_transfer - MX Automated Bank Transfer\n* no_preference - No Preference\n* us_automated_bank_transfer - US Automated Bank Transfer\n* eu_automated_bank_transfer - EU Automated Bank Transfer\n* ach_credit - ACH Credit\n* uk_automated_bank_transfer - UK Automated Bank Transfer\n",
                    "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)\ndisplayed on the invoice PDF.\n",
                    "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)\nfor 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)\nwhich takes precedence.\n",
                    "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/v2/pcv-1/advanced-features)\n.\n",
                    "example" : null
                  },
                  "fraud_flag" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Indicates whether or not the customer has been identified as fraudulent.\n\n* fraudulent - The customer has been marked as fraudulent\n* safe - The customer has been marked as safe\n",
                    "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\n",
                    "properties" : {
                      "provider_name" : {
                        "type" : "array",
                        "description" : "Name of the tax provider.\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",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "field_value" : {
                        "type" : "array",
                        "description" : "The value of the related tax field\n",
                        "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\n"
                    },
                    "card" : {
                      "$ref" : "#/components/schemas/Card",
                      "description" : "Resource object representing card\n"
                    }
                  },
                  "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)\nfor the customer.\n",
        "operationId" : "list_hierarchy_details",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "customer-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/customer-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        }, {
          "name" : "limit",
          "in" : "query",
          "description" : "The number of resources to be returned.\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" : "Used for pagination. Set this to the `next_offset`\nvalue from the previous API response to fetch the next page.\n",
          "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.\n\n* complete_hierarchy - Fetches all nodes in the full hierarchy that the customer belongs to.\n* subordinates - Fetches all nodes in the sub-hierarchy rooted at the customer, including the customer and its subordinates.\n* path_to_root - Fetches a list of nodes along the path from the customer to the root of the hierarchy.\n",
          "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`.\n",
                      "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" : "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*\n(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.\n",
                    "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*\nvalue is derived as per configurations or its specifically set (overriden). When specifically set, the *billing_date*\nwill not be reset even when all of the monthly/yearly subscriptions are cancelled.\n\n* manually_set - Billing date is specifically set (default configuration is overridden)\n* using_defaults - Billing date is set based on defaults configured.\n",
                    "enum" : [ "using_defaults", "manually_set" ],
                    "example" : null
                  },
                  "billing_day_of_week" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Applicable when *calendar billing*\n(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.\n\n* sunday - Sunday\n* wednesday - Wednesday\n* tuesday - Tuesday\n* monday - Monday\n* saturday - Saturday\n* friday - Friday\n* thursday - Thursday\n",
                    "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*\nvalue is derived as per configurations or its specifically set (overriden). When specifically set, the *billing_day_of_week*\nwill not be reset even when all of the weekly subscriptions are cancelled.\n\n* manually_set - Billing date is specifically set (default configuration is overridden)\n* using_defaults - Billing date is set based on defaults configured.\n",
                    "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\n"
                    }
                  },
                  "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.\n",
        "operationId" : "list_customers",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "limit",
          "in" : "query",
          "description" : "The number of resources to be returned.\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`\nto the value of `next_offset`\nobtained in the previous iteration of the API call.\n",
          "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**\n' attribute will be '**true**\n'.\n",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "boolean",
            "default" : false,
            "example" : null
          }
        }, {
          "name" : "id",
          "in" : "query",
          "description" : "optional, string filter\n\nIdentifier of the customer.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*id\\[is_not\\] = \"9bsvnHgsvmsI\"*\n",
          "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\n\nFirst name of the customer.\n**Supported operators :**\nis, is_not, starts_with, is_present\n\n**Example →**\n*first_name\\[is\\] = \"John\"*\n",
          "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\n\nLast name of the customer.\n**Supported operators :**\nis, is_not, starts_with, is_present\n\n**Example →**\n*last_name\\[is\\] = \"Clint\"*\n",
          "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\n\nEmail of the customer. Configured email notifications will be sent to this email.\n**Supported operators :**\nis, is_not, starts_with, is_present\n\n**Example →**\n*email\\[is\\] = \"john@test.com\"*\n",
          "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\n\nCompany name of the customer.\n**Supported operators :**\nis, is_not, starts_with, is_present\n\n**Example →**\n*company\\[is\\] = \"Globex Corp\"*\n",
          "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\n\nPhone number of the customer.\n**Supported operators :**\nis, is_not, starts_with, is_present\n\n**Example →**\n*phone\\[is\\] = \"(541) 754-3010\"*\n",
          "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\n\nWhether payments needs to be collected automatically for this customer. Possible values are : on, off.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*auto_collection\\[is\\] = \"on\"*\n",
          "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.\n* `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.\n* `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.\n* `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.\n* `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\n\nSpecifies if the customer is liable for tax. Possible values are : taxable, exempt, zero_rated.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*taxability\\[is\\] = \"taxable\"*\n",
          "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.\n* `exempt` -\n  * 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.\n  * 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.\n* `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.\n",
                "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.\n* `exempt` -\n  * 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.\n  * 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.\n* `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.\n",
                "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.\n* `exempt` -\n  * 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.\n  * 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.\n* `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.\n",
                "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.\n* `exempt` -\n  * 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.\n  * 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.\n* `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.\n",
                "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\n\nTimestamp indicating when this customer resource is created.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*created_at\\[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\nTo filter based on `updated_at`.\nThis 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`\ninput parameter as `updated_at`\nfor a faster response.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*updated_at\\[on\\] = \"1243545465\"*\n",
          "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\n\nThe preferred offline payment method for the customer. Possible values are : no_preference, cash, check, bank_transfer, ach_credit, sepa_credit.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*offline_payment_method\\[is\\] = \"cash\"*\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "example" : "cash",
            "properties" : {
              "is" : {
                "type" : "string",
                "description" : "* `no_preference` - No Preference\n* `cash` - Cash\n* `check` - Check\n* `bank_transfer` - Bank Transfer\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `boleto` - Boleto\n* `us_automated_bank_transfer` - US Automated Bank Transfer\n* `eu_automated_bank_transfer` - EU Automated Bank Transfer\n* `uk_automated_bank_transfer` - UK Automated Bank Transfer\n* `jp_automated_bank_transfer` - JP Automated Bank Transfer\n* `mx_automated_bank_transfer` - MX Automated Bank Transfer\n* `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\n* `cash` - Cash\n* `check` - Check\n* `bank_transfer` - Bank Transfer\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `boleto` - Boleto\n* `us_automated_bank_transfer` - US Automated Bank Transfer\n* `eu_automated_bank_transfer` - EU Automated Bank Transfer\n* `uk_automated_bank_transfer` - UK Automated Bank Transfer\n* `jp_automated_bank_transfer` - JP Automated Bank Transfer\n* `mx_automated_bank_transfer` - MX Automated Bank Transfer\n* `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\n* `cash` - Cash\n* `check` - Check\n* `bank_transfer` - Bank Transfer\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `boleto` - Boleto\n* `us_automated_bank_transfer` - US Automated Bank Transfer\n* `eu_automated_bank_transfer` - EU Automated Bank Transfer\n* `uk_automated_bank_transfer` - UK Automated Bank Transfer\n* `jp_automated_bank_transfer` - JP Automated Bank Transfer\n* `mx_automated_bank_transfer` - MX Automated Bank Transfer\n* `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\n* `cash` - Cash\n* `check` - Check\n* `bank_transfer` - Bank Transfer\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `boleto` - Boleto\n* `us_automated_bank_transfer` - US Automated Bank Transfer\n* `eu_automated_bank_transfer` - EU Automated Bank Transfer\n* `uk_automated_bank_transfer` - UK Automated Bank Transfer\n* `jp_automated_bank_transfer` - JP Automated Bank Transfer\n* `mx_automated_bank_transfer` - MX Automated Bank Transfer\n* `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\n\nOverride for this customer, the [site-level setting](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing)\nfor 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)\nwhich takes precedence. Possible values are : *true, false*\n\n**Supported operators :**\nis\n\n**Example →**\n*auto_close_invoices\\[is\\] = \"true\"*\n",
          "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\n\nThe subscription channel this object originated from and is maintained in. Possible values are : web, app_store, play_store.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*channel\\[is\\] = \"APP STORE\"*\n",
          "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\n\nThe ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity.  \n**Note**\n\n[Multiple Business Entities](/docs/api/getting-started) is a feature available only on Product Catalog 2.0.\n\n**Supported operators :**\nis, is_not, starts_with\n\n**Example →**\n*business_entity_id\\[is_not\\] = \"business_entity_id\"*\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "example" : "business_entity_id",
            "properties" : {
              "is" : {
                "type" : "string",
                "minLength" : 1,
                "example" : null
              }
            }
          }
        }, {
          "name" : "sort_by",
          "in" : "query",
          "description" : "optional, string filter\n\nSorts based on the specified attribute.\n**Supported attributes :**\ncreated_at, updated_at\n\n**Supported sort-orders :**\nasc, desc\n\n**Example →**\n*sort_by\\[asc\\] = \"created_at\"*\n\nThis will sort the result based on the 'created_at' attribute in ascending(earliest first) order.\n",
          "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\n",
          "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)\n",
                "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\n",
                "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\n",
                "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`.\n",
                      "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" : "**Note:**\nThis operation optionally supports 3DS verification flow. To achieve the same, create the [Payment Intent](/docs/api/v2/pcv-1/3ds_card_payments)\nand pass it as input parameter to this API.\n\nCreates a customer. You can create a customer and then create subscriptions for the customer when required. When creating a customer, you can pass along the billing address and card details.\n\nPassing raw card data via API involves PCI liability at your end due to the sensitivity of the data. Instead, you can use one of the following integration options as applicable:\n\nHere's some resources you can use to collect card information within your checkout form based on the payment gateway you use:\n\n* [Stripe.js](https://stripe.com/docs/js) for Stripe users.\n* [Braintree.js](https://developer.paypal.com/braintree/docs/guides/client-sdk/setup/javascript/v2) for Braintree users.\n* [Accept.js](https://developer.authorize.net/api/reference/features/acceptjs.html), if you use [Authorize.Net](https://www.authorize.net/).\n* If you are using the Adyen gateway, you will have to use the Adyen's [Client-Side Encryption](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/cse-integration-ecommerce) to encrypt sensitive cardholder data. Once the cardholder data is encrypted, pass the value in `adyen.encrypted.data`as temp token in this API.\n* You can also use our [Hosted Pages](https://www.chargebee.com/docs/billing/2.0/hosted-capabilities/hosted-capabilities) based integration.\n\nWhen billing address is not passed (say, for customers making offline payments), you can always provide it later using the [Update billing info for a customer API](/docs/api/customers/update-billing-info-for-a-customer).\n\n**Note:** When an invoice is generated for a customer, the billing address provided for the customer is stored with the invoice. If the First Name, Last Name, and Company fields of the billing address do not contain any information, they're picked up from the customer details.\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
          }
        } ],
        "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.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "first_name" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "First name of the customer.\n",
                    "maxLength" : 150,
                    "example" : null
                  },
                  "last_name" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Last name of the customer.\n",
                    "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.\n",
                    "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.\n",
                    "maxLength" : 3,
                    "example" : null
                  },
                  "phone" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Phone number of the customer.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "company" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Company name of the customer.\n",
                    "maxLength" : 250,
                    "example" : null
                  },
                  "auto_collection" : {
                    "type" : "string",
                    "default" : "on",
                    "deprecated" : false,
                    "description" : "Whether payments needs to be collected automatically for this customer.\n\n* on - Whenever an invoice is created, an automatic attempt to charge the customer's payment method is made.\n* off - Automatic collection of charges will not be made. All payments must be recorded offline.\n",
                    "enum" : [ "on", "off" ],
                    "example" : null
                  },
                  "net_term_days" : {
                    "type" : "integer",
                    "format" : "int32",
                    "default" : 0,
                    "deprecated" : false,
                    "description" : "The number of days within which the customer has to make payment for the invoice.\n",
                    "example" : null
                  },
                  "allow_direct_debit" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "Whether the customer can pay via Direct Debit.\n",
                    "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)\n\n`country`\nas\n`XI`\n(which is **United Kingdom - Northern Ireland**\n), the first two characters of the [full VAT number](https://en.wikipedia.org/wiki/VAT_identification_number)\ncan be overridden by setting\n[vat_number_prefix](/docs/api/customers/customer-object#vat_number_prefix)\n.\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).\nOnly applicable specifically for customers with [billing_address](/docs/api/customers/customer-object#billing_address)\n\n`country`\nas `XI`\n(which is **United Kingdom - Northern Ireland**\n).\n\nWhen you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\nin 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\nthe Brexit configuration, you have the option of setting [billing_address](/docs/api/customers/customer-object#billing_address)\n\n`country`\nas `XI`.\nThat's the code for **United Kingdom - Northern Ireland** .\nThe first two characters of the VAT number in such a case is\n`XI`\nby default. However, if the VAT number was registered in UK, the value should be `GB`.\nSet\n`vat_number_prefix`\nto `GB`\nfor such cases.\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)\nof 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`.\nCurrently 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`\nthen the [Reverse Charge Mechanism](https://www.chargebee.com/docs/australian-gst.html#reverse-charge-mechanism)\nis applicable. This field is applicable only when Australian GST is configured for your site.\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\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.\n\n* automatic - Use this value to send e-invoice every time an invoice or credit note is created.\n* manual - When manual is selected the automatic e-invoice sending is disabled. Use this value to send e-invoice manually through UI or API.\n* site_default - The default value of the site which can be overridden at the customer level.\n",
                    "enum" : [ "automatic", "manual", "site_default" ],
                    "example" : null
                  },
                  "taxability" : {
                    "type" : "string",
                    "default" : "taxable",
                    "deprecated" : false,
                    "description" : "Specifies if the customer is liable for tax.\n\n* 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.\n* taxable -\n  Computes tax for the customer based on the [site configuration](https://www.chargebee.com/docs/tax.html).\n  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.\n* exempt -\n  * 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.\n  * 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.\n",
                    "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)\nintegration.\nTo 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/)\n.\n",
                    "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)\nintegration.\n\n* industrial - When the purchase is made by an industrial business\n* residential - When the purchase is made by a customer for home use\n* 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\n* business - When the purchase is made at a place of business\n",
                    "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)\nintegration.\n",
                    "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.\n\n* other - Other\n* government - Government\n* wholesale - Whole-sale\n",
                    "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.\n",
                    "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.\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)\n.\n\n* l - Other or custom\n* m - Educational organization\n* n - Local government\n* h - Commercial agricultural production\n* i - Industrial production/manufacturer\n* j - Direct pay permit\n* k - Direct mail\n* p - Commercial aquaculture\n* q - Commercial Fishery\n* r - Non-resident\n* d - Foreign diplomat\n* e - Charitable or benevolent organization\n* f - Religious organization\n* g - Resale\n* a - Federal government\n* b - State government\n* c - Tribe/Status Indian/Indian Band\n* med2 - US Medical Device Excise Tax with taxable sales tax\n* med1 - US Medical Device Excise Tax with exempt sales tax\n",
                    "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)\n.\n",
                    "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/v2/pcv-1/advanced-features)\n.\n",
                    "example" : null
                  },
                  "offline_payment_method" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The preferred offline payment method for the customer.\n\n* sepa_credit - SEPA Credit\n* cash - Cash\n* no_preference - No Preference\n* bank_transfer - Bank Transfer\n* check - Check\n* eu_automated_bank_transfer - EU Automated Bank Transfer\n* jp_automated_bank_transfer - JP Automated Bank Transfer\n* uk_automated_bank_transfer - UK Automated Bank Transfer\n* custom - Custom\n* boleto - Boleto\n* mx_automated_bank_transfer - MX Automated Bank Transfer\n* us_automated_bank_transfer - US Automated Bank Transfer\n* ach_credit - ACH Credit\n",
                    "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)\nfor 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)\nwhich takes precedence.\n",
                    "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/1.0/payment-gateways-and-configuration/gateway_settings#smart-routing).\nExplicitly 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 API resource. This note becomes one among [all the notes](/docs/api/invoices/invoice-object#notes)\ndisplayed on the invoice PDF.\n",
                    "maxLength" : 2000,
                    "example" : null
                  },
                  "card" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for card\n",
                    "properties" : {
                      "gateway_account_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The gateway account in which this payment source is stored.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Cardholder's first name\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Cardholder's last name\n",
                        "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)\n, 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.\n",
                        "maximum" : 12,
                        "minimum" : 1,
                        "example" : null
                      },
                      "expiry_year" : {
                        "type" : "integer",
                        "format" : "int32",
                        "deprecated" : false,
                        "description" : "Card expiry year.\n",
                        "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)\n, you can specify the Braintree encrypted CVV here.\n",
                        "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.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "billing_addr2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2, as available in card billing address.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "billing_city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "City, as available in card billing address.\n",
                        "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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `billing_state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "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`\nis provided.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "billing_zip" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Postal or Zip code, as available in card billing address.\n",
                        "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).\n\n  * `payer`: User related information.\n    * `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).\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n    * `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.\n* `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.\n\n  * `fraud`: Fraud identification related information.\n    * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n* `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.\n\n  * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.\n* `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.\n\n  * `payer`: User related information.\n    * `document`: Document is the user's identification number based on their country.\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "bank_account" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for bank_account\n",
                    "properties" : {
                      "gateway_account_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The gateway account in which this payment source is stored.\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)\nplatform, this can be the [local bank details](https://developer.gocardless.com/api-reference/#appendix-local-bank-details)\n",
                        "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.\n",
                        "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.\n",
                        "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.\n",
                        "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.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Phone number of the account holder that is linked to the bank account.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "bank_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Name of account holder's bank.\n",
                        "maxLength" : 100,
                        "example" : null
                      },
                      "account_number" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Account holder's bank account number.\n",
                        "maxLength" : 17,
                        "minLength" : 4,
                        "example" : null
                      },
                      "routing_number" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Bank account routing number.\n",
                        "maxLength" : 9,
                        "minLength" : 3,
                        "example" : null
                      },
                      "bank_code" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Indicates the bank code.\n",
                        "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/)\nACH and Razorpay NetBanking users only. If not passed, account type is taken as null.\n\n* checking - Checking Account\n* business_checking - Business Checking Account\n* savings - Savings Account\n* current - Current Account\n",
                        "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.\n\n* individual - Individual Account.\n* company - Company Account.\n",
                        "enum" : [ "individual", "company" ],
                        "example" : null
                      },
                      "echeck_type" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "For Authorize.net ACH users only. Indicates the type of eCheck.\n\n* ppd - Payment Authorization is prearranged between the customer and the merchant.\n* ccd - Payment Authorization agreement from the corporate customer is required. Applicable for business_checking account_type.\n* web - Payment Authorization obtained from the customer via the internet.\n",
                        "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)\nISO country code. Required when local bank details are provided, and not IBAN.\n",
                        "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.\n",
                        "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.\n\n* `last_name`:(string, max chars=150) The last name of the contact.\n* `company_name`:(string, max chars=250) The company name for the address.\n* `line1`:(string, max chars=180) The first line of the address.\n* `line2`:(string, max chars=180) The second line of the address.\n* `country`:(string) The name of the country for the address.\n* `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.\n* `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.\n* `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`).\n* `city`:(string, max chars=50) The city name for the address.\n* `postal_code`:(string, max chars=20) The postal or ZIP code for the address.\n* `phone`:(string, max chars=50) The contact phone number for the address.\n* `email`:(string, max chars=70) The contact email address for the address.\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "payment_method" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for payment_method\n",
                    "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)\nAPI 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.\n",
                        "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* .\nFor 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:**\nThis is not the one-time temporary token provided by gateways like Stripe.\n\nFor more details refer [Update payment method for a customer](/docs/api/customers/update-payment-method-for-a-customer)\nAPI under Customer resource.\n",
                        "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.\n",
                        "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)\n.\n\n**Note**:\nIf you enter an invalid country code, the system will return an error.\n\nIf you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\nin 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\nthe Brexit configuration, then `XI`\n(the code for **United Kingdom - Northern Ireland**\n) 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).\n\n  * `payer`: User related information.\n    * `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).\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n    * `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.\n* `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.\n\n  * `fraud`: Fraud identification related information.\n    * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n* `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.\n\n  * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.\n* `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.\n\n  * `payer`: User related information.\n    * `document`: Document is the user's identification number based on their country.\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "payment_intent" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for payment_intent\n",
                    "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.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "gateway_account_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The gateway account used for performing the 3DS flow.\n",
                        "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)\nto find out the gateway-specific gw_token format. Applicable when you are using gateway APIs directly for completing the 3DS flow.\n",
                        "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.\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.\n",
                        "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).\n\n  * `payer`: User related information.\n    * `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).\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n    * `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.\n* `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.\n\n  * `fraud`: Fraud identification related information.\n    * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n* `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.\n\n  * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.\n* `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.\n\n  * `payer`: User related information.\n    * `document`: Document is the user's identification number based on their country.\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "billing_address" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for billing_address\n",
                    "properties" : {
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The first name of the billing contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The last name of the billing contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "The email address.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "company" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The company name.\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The phone number.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line3" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 3\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "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`\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.\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.  \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.\n\n* valid - Address was validated successfully.\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n",
                        "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "entity_identifiers" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for entity_identifiers\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "The unique id for the `entity_identifier`\nin Chargebee. When not provided, it is autogenerated.\n",
                        "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)\nof 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\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",
                          "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",
                    "properties" : {
                      "provider_name" : {
                        "type" : "array",
                        "description" : "Name of the tax provider.\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",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "field_value" : {
                        "type" : "array",
                        "description" : "The value of the related tax field\n",
                        "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\n"
                    },
                    "card" : {
                      "$ref" : "#/components/schemas/Card",
                      "description" : "Resource object representing card\n"
                    }
                  },
                  "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" : "Adds the required contact to a customer. You can give the First Name, Last Name, Email ID and more details as input parameters to add them under the desired customer.\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" : "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\n",
                    "properties" : {
                      "id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Unique reference ID provided for the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "First name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Last name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "Email of the contact.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Phone number of the contact.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "label" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Label/Tag provided for contact.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "enabled" : {
                        "type" : "boolean",
                        "default" : false,
                        "deprecated" : false,
                        "description" : "Contact enabled / disabled\n",
                        "example" : null
                      },
                      "send_billing_email" : {
                        "type" : "boolean",
                        "default" : false,
                        "deprecated" : false,
                        "description" : "Whether Billing Emails option is enabled for the contact.\n",
                        "example" : null
                      },
                      "send_account_email" : {
                        "type" : "boolean",
                        "default" : false,
                        "deprecated" : false,
                        "description" : "Whether Account Emails option is enabled for the contact.\n",
                        "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\n"
                    },
                    "card" : {
                      "$ref" : "#/components/schemas/Card",
                      "description" : "Resource object representing card\n"
                    }
                  },
                  "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.\n",
        "operationId" : "list_of_contacts_for_a_customer",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "customer-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/customer-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        }, {
          "name" : "limit",
          "in" : "query",
          "description" : "The number of resources to be returned.\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`\nto the value of `next_offset`\nobtained in the previous iteration of the API call.\n",
          "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`.\n",
                      "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.\n",
        "operationId" : "clear_personal_data_of_a_customer",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "customer-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/customer-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "customer" : {
                      "$ref" : "#/components/schemas/Customer",
                      "description" : "Resource object representing customer\n"
                    }
                  },
                  "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
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "from_customer_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "From customer id.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "to_customer_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "To customer id.\n",
                    "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\n"
                    }
                  },
                  "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:**\nThis operation optionally supports 3DS verification flow. To achieve the same, create the [Payment Intent](/docs/api/getting-started)\nand pass it as input parameter to this API.\n\nThis 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.\n",
        "operationId" : "collect_payment_for_customer",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "customer-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/customer-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "amount" : {
                    "type" : "integer",
                    "format" : "int64",
                    "deprecated" : false,
                    "description" : "Amount to be collected. If this parameter is not passed then the invoice(s) amount to collect will be collected.\n",
                    "minimum" : 0,
                    "example" : null
                  },
                  "payment_source_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Payment source used for the payment.\n",
                    "maxLength" : 40,
                    "example" : null
                  },
                  "token_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Token generated by Chargebee.js representing payment method details.\n",
                    "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.\nIn case of Create Subscription for Customer endpoint, the default value is True. Otherwise, the default value is False.\n",
                    "example" : null
                  },
                  "retain_payment_source" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "Indicates whether the payment source should be retained for the customer.\n",
                    "example" : null
                  },
                  "payment_initiator" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The type of initiator to be used for the payment request triggered by this operation.\n\n* customer - Pass this value to indicate that the request is initiated by the customer\n* merchant - Pass this value to indicate that the request is initiated by the merchant\n",
                    "enum" : [ "customer", "merchant" ],
                    "example" : null
                  },
                  "payment_method" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for payment_method\n",
                    "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)\nAPI 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.\n",
                        "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* .\nFor 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:**\nThis is not the one-time temporary token provided by gateways like Stripe.\n\nFor more details refer [Update payment method for a customer](/docs/api/customers/update-payment-method-for-a-customer)\nAPI under Customer resource.\n",
                        "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.\n",
                        "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).\n\n  * `payer`: User related information.\n    * `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).\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n    * `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.\n* `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.\n\n  * `fraud`: Fraud identification related information.\n    * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n* `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.\n\n  * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.\n* `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.\n\n  * `payer`: User related information.\n    * `document`: Document is the user's identification number based on their country.\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "card" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for card\n",
                    "properties" : {
                      "gateway_account_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The gateway account in which this payment source is stored.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Cardholder's first name\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Cardholder's last name\n",
                        "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)\n, 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.\n",
                        "maximum" : 12,
                        "minimum" : 1,
                        "example" : null
                      },
                      "expiry_year" : {
                        "type" : "integer",
                        "format" : "int32",
                        "deprecated" : false,
                        "description" : "Card expiry year.\n",
                        "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)\n, you can specify the Braintree encrypted CVV here.\n",
                        "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.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "billing_addr2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2, as available in card billing address.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "billing_city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "City, as available in card billing address.\n",
                        "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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `billing_state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "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`\nis provided.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "billing_zip" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Postal or Zip code, as available in card billing address.\n",
                        "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).\n\n  * `payer`: User related information.\n    * `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).\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n    * `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.\n* `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.\n\n  * `fraud`: Fraud identification related information.\n    * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n* `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.\n\n  * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.\n* `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.\n\n  * `payer`: User related information.\n    * `document`: Document is the user's identification number based on their country.\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "payment_intent" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for payment_intent\n",
                    "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.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "gateway_account_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The gateway account used for performing the 3DS flow.\n",
                        "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)\nto find out the gateway-specific gw_token format. Applicable when you are using gateway APIs directly for completing the 3DS flow.\n",
                        "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.\n\n* card - card\n* twint - Payments made via Twint\n* swish - Payments made via Swish\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* thai_qr - Payments made via Thai QR.\n* go_pay - Payments made via GoPay\n* google_pay - google_pay\n* trustly - Trustly\n* naver_pay - Payments made via Naver Pay.\n* stablecoin - Payments made via Stablecoin.\n* paypal_express_checkout - paypal_express_checkout\n* pix - Pix\n* venmo - Venmo\n* klarna_pay_now - Klarna Pay Now\n* alipay - Payments made via Alipay.\n* tamara - Payments made via Tamara.\n* ideal - ideal\n* picpay - Payments made via PicPay.\n* pay_to - PayTo\n* ovo - Payments made via OVO.\n* boleto - boleto\n* pay_co - Payments made via PayCo\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* alipay_hk - Payments made via Alipay HK.\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* mercado_pago - Payments made via Mercado Pago.\n* p24 - Payments made via Przelewy24 (P24).\n* electronic_payment_standard - Electronic Payment Standard\n* direct_debit - direct_debit\n* sepa_instant_transfer - Sepa Instant Transfer\n* bancontact - bancontact\n* wero - Payments made via Wero.\n* pay_by_bank - Pay By Bank\n* touch_n_go - Payments made via Touch 'n Go.\n* apple_pay - apple_pay\n* qpay - Payments made via Qpay.\n* online_banking_poland - Online Banking Poland\n* gcash - Payments made via GCash.\n* nupay - Payments made via NuPay.\n* giropay - giropay\n* momo - Payments made via MoMo.\n* sofort - sofort\n* amazon_payments - Amazon Payments\n* affirm_pay - Payments made via Affirm Pay.\n* kakao_pay - Payments made via Kakao Pay.\n* fpx - Payments made via FPX.\n* blik - Payments made via BLIK.\n* dana - Payments made via Dana.\n* south_korean_cards - Payments made via South Korean Cards\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.\n",
                        "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).\n\n  * `payer`: User related information.\n    * `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).\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n    * `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.\n* `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.\n\n  * `fraud`: Fraud identification related information.\n    * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n* `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.\n\n  * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.\n* `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.\n\n  * `payer`: User related information.\n    * `document`: Document is the user's identification number based on their country.\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "invoice_allocations" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for invoice_allocations\n",
                    "properties" : {
                      "invoice_id" : {
                        "type" : "array",
                        "description" : "Identifier for the invoice. Multiple invoices can be passed.\n",
                        "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)\n.\n",
                        "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\n"
                    },
                    "transaction" : {
                      "$ref" : "#/components/schemas/Transaction",
                      "description" : "Resource object representing transaction\n"
                    }
                  },
                  "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" : "Use this API to record any [excess payments](https://www.chargebee.com/docs/customers.html#excess-payments) made by the customer, such as advance payments. Such payments will be automatically applied to the future invoices. It can also be [manually applied](https://www.chargebee.com/docs/invoice-operations.html#apply-excess-payments) to the existing *Not Paid* or *Payment Due* invoices.\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" : "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.\n",
                    "maxLength" : 300,
                    "example" : null
                  },
                  "transaction" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for transaction\n",
                    "properties" : {
                      "id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The payment transaction ID\n",
                        "maxLength" : 40,
                        "example" : null
                      },
                      "amount" : {
                        "type" : "integer",
                        "format" : "int64",
                        "deprecated" : false,
                        "description" : "The payment transaction amount\n",
                        "minimum" : 0,
                        "example" : null
                      },
                      "currency_code" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The currency code (ISO 4217 format) for the transaction.\n",
                        "maxLength" : 3,
                        "example" : null
                      },
                      "date" : {
                        "type" : "integer",
                        "format" : "unix-time",
                        "deprecated" : false,
                        "description" : "Indicates when this transaction occurred.\n",
                        "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 - Custom\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.\n",
                        "maxLength" : 100,
                        "example" : null
                      },
                      "custom_payment_method_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Identifier of the custom payment method of this transaction.\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\n"
                    },
                    "transaction" : {
                      "$ref" : "#/components/schemas/Transaction",
                      "description" : "Resource object representing transaction\n"
                    }
                  },
                  "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/v2/pcv-1/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" : "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/v2/pcv-1/email_logs) objects for the send request. Each entry describes one email that was sent or attempted.\n",
                      "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.\n",
        "operationId" : "update_contacts_for_a_customer",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "customer-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/customer-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "contact" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for contact\n",
                    "properties" : {
                      "id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Unique reference ID provided for the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "First name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Last name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "Email of the contact.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Phone number of the contact.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "label" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Label/Tag provided for contact.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "enabled" : {
                        "type" : "boolean",
                        "default" : false,
                        "deprecated" : false,
                        "description" : "Contact enabled / disabled\n",
                        "example" : null
                      },
                      "send_billing_email" : {
                        "type" : "boolean",
                        "default" : false,
                        "deprecated" : false,
                        "description" : "Whether Billing Emails option is enabled for the contact.\n",
                        "example" : null
                      },
                      "send_account_email" : {
                        "type" : "boolean",
                        "default" : false,
                        "deprecated" : false,
                        "description" : "Whether Account Emails option is enabled for the contact.\n",
                        "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\n"
                    },
                    "card" : {
                      "$ref" : "#/components/schemas/Card",
                      "description" : "Resource object representing card\n"
                    }
                  },
                  "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/1.0/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/v2/pcv-1/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/v2/pcv-1/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/v2/pcv-1/customers/delink-a-customer) and then call [Link a customer](/docs/api/v2/pcv-1/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" : "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/1.0/account-hierarchy.html#advanced-mode) or from this API request.\n\n* 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.\n* 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.\n",
                    "example" : null
                  },
                  "parent_account_access" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for parent_account_access\n",
                    "properties" : {
                      "portal_edit_child_subscriptions" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Sets parent's level of access to child subscriptions on the Self-Serve Portal.\n\n* yes - The parent account can view and edit the subscriptions of the child account.\n* no - The parent account cannot view or edit the subscriptions of the child account.\n* view_only - The parent account can only view the subscriptions of the child account.\n",
                        "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.\n\n* yes - The parent account can view and download the invoices of the child account.\n* no - The parent account can neither view nor download the invoices of the child account.\n* view_only - The parent account can only view the invoices of the child account.\n",
                        "enum" : [ "yes", "view_only", "no" ],
                        "example" : null
                      },
                      "send_subscription_emails" : {
                        "type" : "boolean",
                        "deprecated" : false,
                        "description" : "If `true`\n, the parent account will receive subscription-related emails sent to the child account.\n",
                        "example" : null
                      },
                      "send_payment_emails" : {
                        "type" : "boolean",
                        "deprecated" : false,
                        "description" : "If `true`\n, the parent account will receive payment-related emails sent to the child account.\n",
                        "example" : null
                      },
                      "send_invoice_emails" : {
                        "type" : "boolean",
                        "deprecated" : false,
                        "description" : "If `true`\n, the parent account will receive invoice-related emails sent to the child account.\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "child_account_access" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "When the customer is part of an [account hierarchy](https://www.chargebee.com/docs/1.0/account-hierarchy.html)\n, this attribute defines the level of access that the customer has to its own information.\n",
                    "properties" : {
                      "portal_edit_subscriptions" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Determines the child's access to its own subscriptions in the Self-Serve Portal.\n\n* view_only - The child account can only view its subscriptions.\n* yes - The child account can view and edit its subscriptions.\n",
                        "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.\n\n* view_only - The child account can view but not download its invoices.\n* no - The child account cannot view or download its own invoices.\n* yes - The child account can both view and download its invoices.\n",
                        "enum" : [ "yes", "view_only", "no" ],
                        "example" : null
                      },
                      "send_subscription_emails" : {
                        "type" : "boolean",
                        "deprecated" : false,
                        "description" : "If `true`\n, the child account receives email notifications for its subscriptions.\n",
                        "example" : null
                      },
                      "send_payment_emails" : {
                        "type" : "boolean",
                        "deprecated" : false,
                        "description" : "If `true`\n, the child account receives email notifications for payment-related activities for its invoices.\n",
                        "example" : null
                      },
                      "send_invoice_emails" : {
                        "type" : "boolean",
                        "deprecated" : false,
                        "description" : "If `true`\n, the child account receives email notifications for its invoices.\n",
                        "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\n"
                    }
                  },
                  "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" : "This method is used for updating the `billing_address` and `vat_number` attributes of the `customer`. For updating the other customer attributes use [Update Customer API](/docs/api/customers/update-a-customer).\n\nDuring this operation, if `billing_address` and `vat_number` are not already present, they're added. Whereas if present, the existing values are replaced with the new values passed. The only exception here is for `entity_identifiers[i]` when `entity_identifiers[operation][i]` is passed as `delete`.\n\n**Note:** When an invoice is generated for a customer, the billing address provided for the customer will be stored with the invoice. If the First Name, Last Name, and Company fields do not contain any information under Billing Info, the same will be picked from Customer Details if the same is available there.Please ensure that the VAT number is provided whenever the billing address is updated, as failing to do so will override any existing VAT numbers if new values are not provided.\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" : "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. For customers with [billing_address](/docs/api/customers/customer-object#billing_address)\n\n`country`\nas\n`XI`\n(which is **United Kingdom - Northern Ireland**\n), the first two characters of the [full VAT number](https://en.wikipedia.org/wiki/VAT_identification_number)\ncan be overridden by setting\n[vat_number_prefix](/docs/api/customers/customer-object#vat_number_prefix)\n.\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).\nOnly applicable specifically for customers with [billing_address](/docs/api/customers/customer-object#billing_address)\n\n`country`\nas `XI`\n(which is **United Kingdom - Northern Ireland**\n).\n\nWhen you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\nin 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\nthe Brexit configuration, you have the option of setting [billing_address](/docs/api/customers/customer-object#billing_address)\n\n`country`\nas `XI`.\nThat's the code for **United Kingdom - Northern Ireland** .\nThe first two characters of the VAT number in such a case is\n`XI`\nby default. However, if the VAT number was registered in UK, the value should be `GB`.\nSet\n`vat_number_prefix`\nto `GB`\nfor such cases.\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)\nof 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`.\nCurrently 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`\nthen the [Reverse Charge Mechanism](https://www.chargebee.com/docs/australian-gst.html#reverse-charge-mechanism)\nis applicable. This field is applicable only when Australian GST is configured for your site.\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",
                    "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.\n\n* automatic - Use this value to send e-invoice every time an invoice or credit note is created.\n* manual - When manual is selected the automatic e-invoice sending is disabled. Use this value to send e-invoice manually through UI or API.\n* site_default - The default value of the site which can be overridden at the customer level.\n",
                    "enum" : [ "automatic", "manual", "site_default" ],
                    "example" : null
                  },
                  "billing_address" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for billing_address\n",
                    "properties" : {
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The first name of the billing contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The last name of the billing contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "The email address.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "company" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The company name.\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The phone number.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line3" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 3\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "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`\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.\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.  \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**E-Invoicing**\n\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.\n\n* invalid - Address is invalid.\n* valid - Address was validated successfully.\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* not_validated - Address is not yet validated.\n",
                        "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "entity_identifiers" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for entity_identifiers\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "The unique id for the `entity_identifier[i]`\nin Chargebee. This is required when `entity_identifier[operation][i]`\nis `update`\nor `delete`\n.\n",
                        "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)\nof 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`\n.\n\n* update -\n  Updates an existing `entity_identifier`\n  for the customer. `entity_identifier[id]`\n  must be provided in this case.\n* delete -\n  Deletes an existing `entity_identifier`\n  for the customer. `entity_identifier[id]`\n  must be provided in this case.\n* create -\n  Creates a new `entity_identifier`\n  for the customer.\n",
                          "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\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",
                          "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",
                    "properties" : {
                      "provider_name" : {
                        "type" : "array",
                        "description" : "Name of the tax provider.\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",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "field_value" : {
                        "type" : "array",
                        "description" : "The value of the related tax field\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\n"
                    },
                    "card" : {
                      "$ref" : "#/components/schemas/Card",
                      "description" : "Resource object representing card\n"
                    }
                  },
                  "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.\n",
        "operationId" : "create_using_vault_temp_token",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "gateway_account_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The gateway account to which the token is associated.\n",
                    "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.\n",
                    "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.\n",
                    "maxLength" : 255,
                    "example" : null
                  },
                  "currency_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Used to derieve Bank Account Scheme by default will take site default currency.\n",
                    "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).\n\n  * `payer`: User related information.\n    * `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).\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n    * `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.\n* `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.\n\n  * `fraud`: Fraud identification related information.\n    * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n* `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.\n\n  * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.\n* `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.\n\n  * `payer`: User related information.\n    * `document`: Document is the user's identification number based on their country.\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device .\n",
                    "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\n",
                    "properties" : {
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Cardholder's first name\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Cardholder's last name\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "expiry_month" : {
                        "type" : "integer",
                        "format" : "int32",
                        "deprecated" : false,
                        "description" : "Card expiry month.\n",
                        "maximum" : 12,
                        "minimum" : 1,
                        "example" : null
                      },
                      "expiry_year" : {
                        "type" : "integer",
                        "format" : "int32",
                        "deprecated" : false,
                        "description" : "Card expiry year.\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "token_billing_address" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for token_billing_address\n",
                    "properties" : {
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1, as available in card billing address.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2, as available in card billing address.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "City, as available in card billing address.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "state" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The state/province name.\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)\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n).\n",
                        "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.\n",
                        "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\n"
                    }
                  },
                  "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.\n",
        "operationId" : "create_a_card_payment_method_token",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "browser_details" : {
                    "type" : "object",
                    "additionalProperties" : true,
                    "deprecated" : false,
                    "example" : null
                  },
                  "card" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for card\n",
                    "properties" : {
                      "gateway_account_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The gateway account in which this payment source is stored.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Cardholder's first name\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Cardholder's last name\n",
                        "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)\n, 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.\n",
                        "maximum" : 12,
                        "minimum" : 1,
                        "example" : null
                      },
                      "expiry_year" : {
                        "type" : "integer",
                        "format" : "int32",
                        "deprecated" : false,
                        "description" : "Card expiry year.\n",
                        "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)\n, you can specify the Braintree encrypted CVV here.\n",
                        "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.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "billing_addr2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2, as available in card billing address.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "billing_city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "City, as available in card billing address.\n",
                        "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)\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `billing_state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n).\n",
                        "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`\nis provided.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "billing_zip" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Postal or Zip code, as available in card billing address.\n",
                        "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).\n\n  * `payer`: User related information.\n    * `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).\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n    * `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.\n* `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.\n\n  * `fraud`: Fraud identification related information.\n    * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n* `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.\n\n  * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.\n* `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.\n\n  * `payer`: User related information.\n    * `document`: Document is the user's identification number based on their country.\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device\n",
                        "example" : null
                      },
                      "card_type" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Type of the card\n\n* not_applicable - Used for offline entries in transactions. Not applicable for cards\n* visa - A Visa card.\n* electronic_payment_standard - Electronic Payment Standard\n* jcb - A JCB card.\n* kbc_payment_button - KBC Payment Button\n* diners_club - A Diner's Club card.\n* other - Card belonging to types other than those listed above.\n* discover - A Discover card.\n* american_express - An American Express card.\n* bancontact - A Bancontact card.\n* pay_by_bank - Pay By Bank\n* mastercard - A MasterCard.\n* trustly - Trustly\n",
                        "enum" : [ "visa", "mastercard", "american_express", "discover", "jcb", "diners_club", "bancontact", "cmr_falabella", "tarjeta_naranja", "nativa", "cencosud", "cabal", "argencard", "elo", "hipercard", "carnet", "rupay", "maestro", "dankort", "cartes_bancaires", "mada", "other", "not_applicable" ],
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "maxLength" : 70,
                        "example" : null
                      }
                    },
                    "required" : [ "expiry_month", "expiry_year", "number" ],
                    "example" : null
                  }
                },
                "example" : null
              },
              "encoding" : {
                "card" : {
                  "style" : "deepObject",
                  "explode" : true
                }
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "token" : {
                      "$ref" : "#/components/schemas/Token",
                      "description" : "Resource object representing token\n"
                    }
                  },
                  "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.\n",
        "operationId" : "retrieve_a_token",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "cb-token-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/cb-token-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "token" : {
                      "$ref" : "#/components/schemas/Token",
                      "description" : "Resource object representing token\n"
                    }
                  },
                  "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" : "This API provides an alternative way to create a payment source using a permanent token, instead of having to add the full payment method details via API or the Chargebee UI. Permanent tokens are provided by payment gateways such as Stripe.  \nStoring card after successful 3DS completion is not supported in this API. Use [create using Payment Intent API](/docs/api/payment_sources/create-using-payment-intent)\nunder Payment source to store the card after successful 3DS flow completion.\n",
        "operationId" : "create_using_permanent_token",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "customer_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Identifier of the customer with whom this payment source is associated.\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)\nAPI 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.\n",
                    "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.\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.\nIn case of Create Subscription for Customer endpoint, the default value is True. Otherwise, the default value is False.\n",
                    "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).\nEnter 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:**\nCurrently, 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).\n\n  * `payer`: User related information.\n    * `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).\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n    * `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.\n* `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.\n\n  * `fraud`: Fraud identification related information.\n    * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n* `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.\n\n  * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.\n* `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.\n\n  * `payer`: User related information.\n    * `document`: Document is the user's identification number based on their country.\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device .\n",
                    "example" : null
                  },
                  "card" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters of tokenized card details\n",
                    "properties" : {
                      "last4" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Last four digits of the card number\n",
                        "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\n",
                        "maxLength" : 6,
                        "minLength" : 6,
                        "example" : null
                      },
                      "expiry_month" : {
                        "type" : "integer",
                        "format" : "int32",
                        "deprecated" : false,
                        "description" : "Card expiry month.\n",
                        "maximum" : 12,
                        "minimum" : 1,
                        "example" : null
                      },
                      "expiry_year" : {
                        "type" : "integer",
                        "format" : "int32",
                        "deprecated" : false,
                        "description" : "Card expiry year.\n",
                        "example" : null
                      },
                      "brand" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Card brand\n\n* cabal - A Cabal card.\n* cartes_bancaires - A Cartes Bancaires card.\n* american_express - An American Express card.\n* visa - A Visa card.\n* cencosud - A Cencosud card.\n* maestro - A Maestro card.\n* carnet - A Carnet card.\n* argencard - An Argencard.\n* dankort - A Dankort card.\n* tarjeta_naranja - A Tarjeta Naranja card.\n* mastercard - A MasterCard.\n* jcb - A JCB card.\n* hipercard - An Hipercard.\n* other - Card belonging to types other than those listed above.\n* bancontact - A Bancontact card.\n* cmr_falabella - A CMR Falabella card.\n* rupay - A Rupay card.\n* nativa - A Nativa card.\n* discover - A Discover card.\n* elo - A Elo card.\n* diners_club - A Diner's Club card.\n* mada - A Mada card.\n",
                        "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\n\n* not_known - An unknown card.\n* debit - A debit card.\n* credit - A credit card.\n* prepaid - A prepaid card.\n",
                        "enum" : [ "credit", "debit", "prepaid", "not_known" ],
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "billing_address" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for billing_address\n",
                    "properties" : {
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The first name of the billing contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The last name of the billing contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "The email address.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line3" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 3\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "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`\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.\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.  \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\n"
                    },
                    "payment_source" : {
                      "$ref" : "#/components/schemas/PaymentSource",
                      "description" : "Resource object representing payment_source\n"
                    }
                  },
                  "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" : "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\n"
                    },
                    "payment_source" : {
                      "$ref" : "#/components/schemas/PaymentSource",
                      "description" : "Resource object representing payment_source\n"
                    }
                  },
                  "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)\nunder Payment source to store the card after successful 3DS flow completion.\n",
        "operationId" : "create_a_card_payment_source",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "customer_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Identifier of the customer with whom this payment source is associated.\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.\nIn case of Create Subscription for Customer endpoint, the default value is True. Otherwise, the default value is False.\n",
                    "example" : null
                  },
                  "card" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for card\n",
                    "properties" : {
                      "gateway_account_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The gateway account in which this payment source is stored.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Cardholder's first name\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Cardholder's last name\n",
                        "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)\n, 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.\n",
                        "maximum" : 12,
                        "minimum" : 1,
                        "example" : null
                      },
                      "expiry_year" : {
                        "type" : "integer",
                        "format" : "int32",
                        "deprecated" : false,
                        "description" : "Card expiry year.\n",
                        "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)\n, you can specify the Braintree encrypted CVV here.\n",
                        "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.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "billing_addr2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2, as available in card billing address.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "billing_city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "City, as available in card billing address.\n",
                        "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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `billing_state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "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`\nis provided.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "billing_zip" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Postal or Zip code, as available in card billing address.\n",
                        "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).\n\n  * `payer`: User related information.\n    * `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).\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n    * `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.\n* `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.\n\n  * `fraud`: Fraud identification related information.\n    * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n* `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.\n\n  * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.\n* `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.\n\n  * `payer`: User related information.\n    * `document`: Document is the user's identification number based on their country.\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device\n",
                        "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\n"
                    },
                    "payment_source" : {
                      "$ref" : "#/components/schemas/PaymentSource",
                      "description" : "Resource object representing payment_source\n"
                    }
                  },
                  "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.\n",
        "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" : "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.\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.\n",
          "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`'.\n",
          "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`.\n",
                      "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" : "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.\n",
                    "minimum" : 0,
                    "example" : null
                  },
                  "amount2" : {
                    "type" : "integer",
                    "format" : "int64",
                    "deprecated" : false,
                    "description" : "Value of the micro-deposits sent to the bank account.\n",
                    "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\n"
                    }
                  },
                  "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\n",
        "operationId" : "list_payment_sources",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "limit",
          "in" : "query",
          "description" : "The number of resources to be returned.\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`\nto the value of `next_offset`\nobtained in the previous iteration of the API call.\n",
          "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`\nassociated to it.\n",
          "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`\n' as '`true`\n'.\n",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "boolean",
            "default" : false,
            "example" : null
          }
        }, {
          "name" : "customer_id",
          "in" : "query",
          "description" : "optional, string filter\n\nTo filter based on Customer Id.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*customer_id\\[is_not\\] = \"3bdjnDnsdQn\"*\n",
          "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\n\nType 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.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*type\\[is\\] = \"card\"*\n",
          "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.\n* `paypal_express_checkout` - Payments made via PayPal Express Checkout.\n* `amazon_payments` - Payments made via Amazon Payments.\n* `direct_debit` - Represents bank account for which the direct debit or ACH agreement/mandate is created.\n* `generic` - Payments made via Generic Payment Method.\n* `alipay` - Payments made via Alipay\n* `unionpay` - Payments made via UnionPay.\n* `apple_pay` - Payments made via Apple Pay.\n* `wechat_pay` - Payments made via WeChat Pay\n* `ideal` - Payments made via iDEAL.\n* `google_pay` - Payments made via Google Pay.\n* `sofort` - Payments made via Sofort.\n* `bancontact` - Payments made via Bancontact Card.\n* `giropay` - Payments made via giropay.\n* `dotpay` - Payments made via Dotpay.\n* `upi` - UPI Payments.\n* `netbanking_emandates` - Netbanking (eMandates) Payments.\n* `venmo` - Payments made via Venmo\n* `pay_to` - Payments made via PayTo\n* `faster_payments` - Payments made via Faster Payments\n* `sepa_instant_transfer` - Payments made via Sepa Instant Transfer\n* `automated_bank_transfer` - Represents virtual bank account using which the payment will be done.\n* `klarna_pay_now` - Payments made via Klarna Pay Now\n* `online_banking_poland` - Payments made via Online Banking Poland\n* `payconiq_by_bancontact` - Payments made via Payconiq by Bancontact\n* `electronic_payment_standard` - Payments made via Electronic Payment Standard.\n* `kbc_payment_button` - Payments made via KBC Payment Button.\n* `pay_by_bank` - Payments made via Pay By Bank.\n* `trustly` - Payments made via Trustly.\n* `stablecoin` - Payments made via Stablecoin\n* `kakao_pay` - Payments made via Kakao Pay\n* `naver_pay` - Payments made via Naver Pay\n* `revolut_pay` - Payments made via Revolut Pay\n* `cash_app_pay` - Payments made via Cash App Pay\n* `twint` - Payments made via Twint\n* `go_pay` - Payments made via Go Pay\n* `grab_pay` - Payments made via Grab Pay\n* `pay_co` - Payments made via Pay Co\n* `after_pay` - Payments made via After pay\n* `swish` - Payments made via Swish\n* `payme` - Payments made via PayMe\n* `pix` - Payments made via Pix\n* `klarna` - Payments made via Klarna\n* `alipay_hk` - Payments made via Alipay HK\n* `paypay` - Payments made via PayPay\n* `gcash` - Payments made via GCash\n* `south_korean_cards` - Payments made via South Korean Cards\n* `paynow` - Payments made via PayNow\n* `bizum` - Payments made via Bizum\n* `promptpay` - Payments made via PromptPay\n* `dana` - Payments made via Dana\n* `touch_n_go` - Payments made via Touch 'n Go\n* `tamara` - Payments made via Tamara\n* `qpay` - Payments made via Qpay\n* `ovo` - Payments made via OVO.\n* `momo` - Payments made via MoMo.\n* `mercado_pago` - Payments made via Mercado Pago.\n* `nequi` - Payments made via Nequi.\n* `nupay` - Payments made via NuPay.\n* `picpay` - Payments made via PicPay.\n* `thai_qr` - Payments made via Thai QR.\n* `blik` - Payments made via BLIK.\n* `fpx` - Payments made via FPX.\n* `wero` - Payments made via Wero.\n* `p24` - Payments made via Przelewy24 (P24).\n* `affirm_pay` - Payments made via Affirm Pay.\n* `rakuten_pay` - Payments made via Rakuten 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
              },
              "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.\n* `paypal_express_checkout` - Payments made via PayPal Express Checkout.\n* `amazon_payments` - Payments made via Amazon Payments.\n* `direct_debit` - Represents bank account for which the direct debit or ACH agreement/mandate is created.\n* `generic` - Payments made via Generic Payment Method.\n* `alipay` - Payments made via Alipay\n* `unionpay` - Payments made via UnionPay.\n* `apple_pay` - Payments made via Apple Pay.\n* `wechat_pay` - Payments made via WeChat Pay\n* `ideal` - Payments made via iDEAL.\n* `google_pay` - Payments made via Google Pay.\n* `sofort` - Payments made via Sofort.\n* `bancontact` - Payments made via Bancontact Card.\n* `giropay` - Payments made via giropay.\n* `dotpay` - Payments made via Dotpay.\n* `upi` - UPI Payments.\n* `netbanking_emandates` - Netbanking (eMandates) Payments.\n* `venmo` - Payments made via Venmo\n* `pay_to` - Payments made via PayTo\n* `faster_payments` - Payments made via Faster Payments\n* `sepa_instant_transfer` - Payments made via Sepa Instant Transfer\n* `automated_bank_transfer` - Represents virtual bank account using which the payment will be done.\n* `klarna_pay_now` - Payments made via Klarna Pay Now\n* `online_banking_poland` - Payments made via Online Banking Poland\n* `payconiq_by_bancontact` - Payments made via Payconiq by Bancontact\n* `electronic_payment_standard` - Payments made via Electronic Payment Standard.\n* `kbc_payment_button` - Payments made via KBC Payment Button.\n* `pay_by_bank` - Payments made via Pay By Bank.\n* `trustly` - Payments made via Trustly.\n* `stablecoin` - Payments made via Stablecoin\n* `kakao_pay` - Payments made via Kakao Pay\n* `naver_pay` - Payments made via Naver Pay\n* `revolut_pay` - Payments made via Revolut Pay\n* `cash_app_pay` - Payments made via Cash App Pay\n* `twint` - Payments made via Twint\n* `go_pay` - Payments made via Go Pay\n* `grab_pay` - Payments made via Grab Pay\n* `pay_co` - Payments made via Pay Co\n* `after_pay` - Payments made via After pay\n* `swish` - Payments made via Swish\n* `payme` - Payments made via PayMe\n* `pix` - Payments made via Pix\n* `klarna` - Payments made via Klarna\n* `alipay_hk` - Payments made via Alipay HK\n* `paypay` - Payments made via PayPay\n* `gcash` - Payments made via GCash\n* `south_korean_cards` - Payments made via South Korean Cards\n* `paynow` - Payments made via PayNow\n* `bizum` - Payments made via Bizum\n* `promptpay` - Payments made via PromptPay\n* `dana` - Payments made via Dana\n* `touch_n_go` - Payments made via Touch 'n Go\n* `tamara` - Payments made via Tamara\n* `qpay` - Payments made via Qpay\n* `ovo` - Payments made via OVO.\n* `momo` - Payments made via MoMo.\n* `mercado_pago` - Payments made via Mercado Pago.\n* `nequi` - Payments made via Nequi.\n* `nupay` - Payments made via NuPay.\n* `picpay` - Payments made via PicPay.\n* `thai_qr` - Payments made via Thai QR.\n* `blik` - Payments made via BLIK.\n* `fpx` - Payments made via FPX.\n* `wero` - Payments made via Wero.\n* `p24` - Payments made via Przelewy24 (P24).\n* `affirm_pay` - Payments made via Affirm Pay.\n* `rakuten_pay` - Payments made via Rakuten 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
              },
              "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.\n* `paypal_express_checkout` - Payments made via PayPal Express Checkout.\n* `amazon_payments` - Payments made via Amazon Payments.\n* `direct_debit` - Represents bank account for which the direct debit or ACH agreement/mandate is created.\n* `generic` - Payments made via Generic Payment Method.\n* `alipay` - Payments made via Alipay\n* `unionpay` - Payments made via UnionPay.\n* `apple_pay` - Payments made via Apple Pay.\n* `wechat_pay` - Payments made via WeChat Pay\n* `ideal` - Payments made via iDEAL.\n* `google_pay` - Payments made via Google Pay.\n* `sofort` - Payments made via Sofort.\n* `bancontact` - Payments made via Bancontact Card.\n* `giropay` - Payments made via giropay.\n* `dotpay` - Payments made via Dotpay.\n* `upi` - UPI Payments.\n* `netbanking_emandates` - Netbanking (eMandates) Payments.\n* `venmo` - Payments made via Venmo\n* `pay_to` - Payments made via PayTo\n* `faster_payments` - Payments made via Faster Payments\n* `sepa_instant_transfer` - Payments made via Sepa Instant Transfer\n* `automated_bank_transfer` - Represents virtual bank account using which the payment will be done.\n* `klarna_pay_now` - Payments made via Klarna Pay Now\n* `online_banking_poland` - Payments made via Online Banking Poland\n* `payconiq_by_bancontact` - Payments made via Payconiq by Bancontact\n* `electronic_payment_standard` - Payments made via Electronic Payment Standard.\n* `kbc_payment_button` - Payments made via KBC Payment Button.\n* `pay_by_bank` - Payments made via Pay By Bank.\n* `trustly` - Payments made via Trustly.\n* `stablecoin` - Payments made via Stablecoin\n* `kakao_pay` - Payments made via Kakao Pay\n* `naver_pay` - Payments made via Naver Pay\n* `revolut_pay` - Payments made via Revolut Pay\n* `cash_app_pay` - Payments made via Cash App Pay\n* `twint` - Payments made via Twint\n* `go_pay` - Payments made via Go Pay\n* `grab_pay` - Payments made via Grab Pay\n* `pay_co` - Payments made via Pay Co\n* `after_pay` - Payments made via After pay\n* `swish` - Payments made via Swish\n* `payme` - Payments made via PayMe\n* `pix` - Payments made via Pix\n* `klarna` - Payments made via Klarna\n* `alipay_hk` - Payments made via Alipay HK\n* `paypay` - Payments made via PayPay\n* `gcash` - Payments made via GCash\n* `south_korean_cards` - Payments made via South Korean Cards\n* `paynow` - Payments made via PayNow\n* `bizum` - Payments made via Bizum\n* `promptpay` - Payments made via PromptPay\n* `dana` - Payments made via Dana\n* `touch_n_go` - Payments made via Touch 'n Go\n* `tamara` - Payments made via Tamara\n* `qpay` - Payments made via Qpay\n* `ovo` - Payments made via OVO.\n* `momo` - Payments made via MoMo.\n* `mercado_pago` - Payments made via Mercado Pago.\n* `nequi` - Payments made via Nequi.\n* `nupay` - Payments made via NuPay.\n* `picpay` - Payments made via PicPay.\n* `thai_qr` - Payments made via Thai QR.\n* `blik` - Payments made via BLIK.\n* `fpx` - Payments made via FPX.\n* `wero` - Payments made via Wero.\n* `p24` - Payments made via Przelewy24 (P24).\n* `affirm_pay` - Payments made via Affirm Pay.\n* `rakuten_pay` - Payments made via Rakuten 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" ],
                "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.\n* `paypal_express_checkout` - Payments made via PayPal Express Checkout.\n* `amazon_payments` - Payments made via Amazon Payments.\n* `direct_debit` - Represents bank account for which the direct debit or ACH agreement/mandate is created.\n* `generic` - Payments made via Generic Payment Method.\n* `alipay` - Payments made via Alipay\n* `unionpay` - Payments made via UnionPay.\n* `apple_pay` - Payments made via Apple Pay.\n* `wechat_pay` - Payments made via WeChat Pay\n* `ideal` - Payments made via iDEAL.\n* `google_pay` - Payments made via Google Pay.\n* `sofort` - Payments made via Sofort.\n* `bancontact` - Payments made via Bancontact Card.\n* `giropay` - Payments made via giropay.\n* `dotpay` - Payments made via Dotpay.\n* `upi` - UPI Payments.\n* `netbanking_emandates` - Netbanking (eMandates) Payments.\n* `venmo` - Payments made via Venmo\n* `pay_to` - Payments made via PayTo\n* `faster_payments` - Payments made via Faster Payments\n* `sepa_instant_transfer` - Payments made via Sepa Instant Transfer\n* `automated_bank_transfer` - Represents virtual bank account using which the payment will be done.\n* `klarna_pay_now` - Payments made via Klarna Pay Now\n* `online_banking_poland` - Payments made via Online Banking Poland\n* `payconiq_by_bancontact` - Payments made via Payconiq by Bancontact\n* `electronic_payment_standard` - Payments made via Electronic Payment Standard.\n* `kbc_payment_button` - Payments made via KBC Payment Button.\n* `pay_by_bank` - Payments made via Pay By Bank.\n* `trustly` - Payments made via Trustly.\n* `stablecoin` - Payments made via Stablecoin\n* `kakao_pay` - Payments made via Kakao Pay\n* `naver_pay` - Payments made via Naver Pay\n* `revolut_pay` - Payments made via Revolut Pay\n* `cash_app_pay` - Payments made via Cash App Pay\n* `twint` - Payments made via Twint\n* `go_pay` - Payments made via Go Pay\n* `grab_pay` - Payments made via Grab Pay\n* `pay_co` - Payments made via Pay Co\n* `after_pay` - Payments made via After pay\n* `swish` - Payments made via Swish\n* `payme` - Payments made via PayMe\n* `pix` - Payments made via Pix\n* `klarna` - Payments made via Klarna\n* `alipay_hk` - Payments made via Alipay HK\n* `paypay` - Payments made via PayPay\n* `gcash` - Payments made via GCash\n* `south_korean_cards` - Payments made via South Korean Cards\n* `paynow` - Payments made via PayNow\n* `bizum` - Payments made via Bizum\n* `promptpay` - Payments made via PromptPay\n* `dana` - Payments made via Dana\n* `touch_n_go` - Payments made via Touch 'n Go\n* `tamara` - Payments made via Tamara\n* `qpay` - Payments made via Qpay\n* `ovo` - Payments made via OVO.\n* `momo` - Payments made via MoMo.\n* `mercado_pago` - Payments made via Mercado Pago.\n* `nequi` - Payments made via Nequi.\n* `nupay` - Payments made via NuPay.\n* `picpay` - Payments made via PicPay.\n* `thai_qr` - Payments made via Thai QR.\n* `blik` - Payments made via BLIK.\n* `fpx` - Payments made via FPX.\n* `wero` - Payments made via Wero.\n* `p24` - Payments made via Przelewy24 (P24).\n* `affirm_pay` - Payments made via Affirm Pay.\n* `rakuten_pay` - Payments made via Rakuten 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" ],
                "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\n\nCurrent status of the payment source. Possible values are : valid, expiring, expired, invalid, pending_verification.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*status\\[is\\] = \"valid\"*\n",
          "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.\n* `expiring` - A payment source that is expiring (like card's status based on its expiry date).\n* `expired` - A payment source that has expired\n* `invalid` - The billing agreement cannot be used. It might become valid again either automatically or due to  customer action.\n* `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.\n* `expiring` - A payment source that is expiring (like card's status based on its expiry date).\n* `expired` - A payment source that has expired\n* `invalid` - The billing agreement cannot be used. It might become valid again either automatically or due to  customer action.\n* `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.\n* `expiring` - A payment source that is expiring (like card's status based on its expiry date).\n* `expired` - A payment source that has expired\n* `invalid` - The billing agreement cannot be used. It might become valid again either automatically or due to  customer action.\n* `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.\n* `expiring` - A payment source that is expiring (like card's status based on its expiry date).\n* `expired` - A payment source that has expired\n* `invalid` - The billing agreement cannot be used. It might become valid again either automatically or due to  customer action.\n* `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\n\nTimestamp indicating when this payment source resource was last updated.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*updated_at\\[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" : "created_at",
          "in" : "query",
          "description" : "optional, timestamp(UTC) in seconds filter\n\nTimestamp indicating when this payment source resource is created.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*created_at\\[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" : "sort_by",
          "in" : "query",
          "description" : "optional, string filter\n\nSorts based on the specified attribute.\n**Supported attributes :**\ncreated_at, updated_at\n\n**Supported sort-orders :**\nasc, desc\n\n**Example →**\n*sort_by\\[asc\\] = \"created_at\"*\n\nThis will sort the result based on the 'created_at' attribute in ascending(earliest first) order.\n",
          "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`.\n",
                      "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" : "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.\n",
                    "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\n"
                    }
                  },
                  "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)\non the 3DS implementation via Chargebee APIs.\n",
        "operationId" : "create_using_payment_intent",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "customer_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Identifier of the customer with whom this payment source is associated.\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.\nIn case of Create Subscription for Customer endpoint, the default value is True. Otherwise, the default value is False.\n",
                    "example" : null
                  },
                  "payment_intent" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for payment_intent\n",
                    "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.\n",
                        "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.\n",
                        "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)\nto find out the gateway-specific gw_token format. Applicable when you are using gateway APIs directly for completing the 3DS flow.\n",
                        "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.\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.\n",
                        "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).\nPass a stringified JSON containing the `device_session_id`\nand `fraud_merchant_id`\nas an input to `fingerprint`.\nHere's a [sample](/docs/api/payment_parameters)\nto it.\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://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal).\n\n  * `payer`: User related information.\n    * `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).\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n    * `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.\n* `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.\n\n  * `fraud`: Fraud identification related information.\n    * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n* `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.\n\n  * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.\n* `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.\n\n  * `payer`: User related information.\n    * `document`: Document is the user's identification number based on their country.\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device\n",
                        "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\n"
                    },
                    "payment_source" : {
                      "$ref" : "#/components/schemas/PaymentSource",
                      "description" : "Resource object representing payment_source\n"
                    }
                  },
                  "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.\n",
        "operationId" : "retrieve_a_payment_source",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "cust-payment-source-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/cust-payment-source-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "payment_source" : {
                      "$ref" : "#/components/schemas/PaymentSource",
                      "description" : "Resource object representing payment_source\n"
                    }
                  },
                  "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.\n",
        "operationId" : "create_a_voucher_payment_method",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "customer_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Identifier of the customer with whom this payment source is associated.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "voucher_payment_source" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for voucher_payment_source\n",
                    "properties" : {
                      "voucher_type" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Voucher based payment methods\n\n* boleto - Boleto\n",
                        "enum" : [ "boleto" ],
                        "example" : null
                      },
                      "gateway_account_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The gateway account to which the payment method is associated.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "tax_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Customer Tax id\n",
                        "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.\n\n* `last_name`:(string, max chars=150) The last name of the contact.\n* `line1`:(string, max chars=180) The first line of the address.\n* `line2`:(string, max chars=180) The second line of the address.\n* `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.\n* `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)`.\n* `city`:(string, max chars=50) The city name for the address.\n* `postal_code`:(string, max chars=20) The postal or ZIP code for the address.\n* `phone`:(string, max chars=50) The contact phone number for the address.\n* `email`:(string, max chars=70) The contact email address for the address.\n",
                        "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\n"
                    },
                    "payment_source" : {
                      "$ref" : "#/components/schemas/PaymentSource",
                      "description" : "Resource object representing payment_source\n"
                    }
                  },
                  "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)\nunder Payment source to store the card after successful 3DS flow completion.\n",
        "operationId" : "create_using_gateway_temporary_token",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "customer_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Identifier of the customer with whom this payment source is associated.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "gateway_account_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The gateway account to which the payment source is associated.\n",
                    "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 using 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.\n",
                    "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.\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.\nIn case of Create Subscription for Customer endpoint, the default value is True. Otherwise, the default value is False.\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).\n\n  * `payer`: User related information.\n    * `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).\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n    * `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.\n* `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.\n\n  * `fraud`: Fraud identification related information.\n    * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n* `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.\n\n  * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.\n* `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.\n\n  * `payer`: User related information.\n    * `document`: Document is the user's identification number based on their country.\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device .\n",
                    "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\n"
                    },
                    "payment_source" : {
                      "$ref" : "#/components/schemas/PaymentSource",
                      "description" : "Resource object representing payment_source\n"
                    }
                  },
                  "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\nIn **Stripe** and **Braintree** payment gateways, changes in card details are auto-updated. This feature can also be used for other payment gateways in which auto-update is not enabled or is not supported by Chargebee.  \n**Note**\n: This endpoint supports Chargebee Test Gateway, [Stripe](https://www.chargebee.com/docs/1.0/stripe.html)\n, [Braintree](https://www.chargebee.com/docs/1.0/braintree.html)\n, [Authorize.net](https://www.chargebee.com/docs/1.0/authorize-index.html)\n, [Worldpay US eCom](https://www.chargebee.com/docs/1.0/vantiv_worldpay.html)\n, and [WorldPay Direct Integration](https://www.chargebee.com/docs/1.0/worldpay-direct.html)\n. For all other gateways, your customers must re-enter the full [card details](/docs/api/payment_sources/update-a-card-payment-source#card_first_name)\nto 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)\nparameter. 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)\nobject.\n",
        "operationId" : "update_a_card_payment_source",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "cust-payment-source-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/cust-payment-source-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "gateway_meta_data" : {
                    "type" : "object",
                    "additionalProperties" : true,
                    "deprecated" : false,
                    "description" : "Additional data about this resource can be passed to **Stripe**\ngateway here in the JSON Format. This will be stored along with payment source at the gateway account.\n",
                    "example" : null
                  },
                  "reference_transaction" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Reference transaction is used for future purchases. This is only applicable for Vantiv.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "card" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for card\n",
                    "properties" : {
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Cardholder's first name\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Cardholder's last name\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "expiry_month" : {
                        "type" : "integer",
                        "format" : "int32",
                        "deprecated" : false,
                        "description" : "Card expiry month.\n",
                        "maximum" : 12,
                        "minimum" : 1,
                        "example" : null
                      },
                      "expiry_year" : {
                        "type" : "integer",
                        "format" : "int32",
                        "deprecated" : false,
                        "description" : "Card expiry year.\n",
                        "example" : null
                      },
                      "billing_addr1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1, as available in card billing address.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "billing_addr2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2, as available in card billing address.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "billing_city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "City, as available in card billing address.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "billing_zip" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Postal or Zip code, as available in card billing address.\n",
                        "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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `billing_state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "billing_state" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The state/province name.\n",
                        "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.\n\n  * `payer`: User related information.\n    * `document`: Document is the user's identification number based on their country.\n",
                        "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\n"
                    },
                    "payment_source" : {
                      "$ref" : "#/components/schemas/PaymentSource",
                      "description" : "Resource object representing payment_source\n"
                    }
                  },
                  "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" : "Switches the gateway in which this payment source information is stored.\n\nThis is applicable only if the payment source is present in Spreedly vault.  \nThis operation does not support switching between Braintree and Stripe. If you need help using this API, contact [Chargebee Support](https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support).\n",
        "operationId" : "switch_gateway_account",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "cust-payment-source-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/cust-payment-source-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "gateway_account_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The gateway account you want to switch to.\n",
                    "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\n"
                    },
                    "payment_source" : {
                      "$ref" : "#/components/schemas/PaymentSource",
                      "description" : "Resource object representing payment_source\n"
                    }
                  },
                  "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)\nunder Payment source to store the card after successful 3DS flow completion.\n",
        "operationId" : "create_using_chargebee_token",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "customer_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Identifier of the customer with whom this payment source is associated.\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.\nIn case of Create Subscription for Customer endpoint, the default value is True. Otherwise, the default value is False.\n",
                    "example" : null
                  },
                  "token_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Token generated by Chargebee.js representing payment method details.\n",
                    "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\n"
                    },
                    "payment_source" : {
                      "$ref" : "#/components/schemas/PaymentSource",
                      "description" : "Resource object representing payment_source\n"
                    }
                  },
                  "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" : "Deletes a payment method from Chargebee. Payment method in the payment gateway will not be affected.\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" : "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\n"
                    },
                    "payment_source" : {
                      "$ref" : "#/components/schemas/PaymentSource",
                      "description" : "Resource object representing payment_source\n"
                    }
                  },
                  "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
          }
        } ],
        "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.\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.\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.\nIn case of Create Subscription for Customer endpoint, the default value is True. Otherwise, the default value is False.\n",
                    "example" : null
                  },
                  "bank_account" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for bank_account\n",
                    "properties" : {
                      "gateway_account_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The gateway account in which this payment source is stored.\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)\nplatform, this can be the [local bank details](https://developer.gocardless.com/api-reference/#appendix-local-bank-details)\n",
                        "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.\n",
                        "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.\n",
                        "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.\n",
                        "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.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Phone number of the account holder that is linked to the bank account.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "bank_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Name of account holder's bank.\n",
                        "maxLength" : 100,
                        "example" : null
                      },
                      "account_number" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Account holder's bank account number.\n",
                        "maxLength" : 17,
                        "minLength" : 4,
                        "example" : null
                      },
                      "routing_number" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Bank account routing number.\n",
                        "maxLength" : 9,
                        "minLength" : 3,
                        "example" : null
                      },
                      "bank_code" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Indicates the bank code.\n",
                        "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/)\nACH and Razorpay NetBanking users only. If not passed, account type is taken as null.\n\n* current - Current Account\n* savings - Savings Account\n* checking - Checking Account\n* business_checking - Business Checking Account\n",
                        "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.\n\n* company - Company Account.\n* individual - Individual Account.\n",
                        "enum" : [ "individual", "company" ],
                        "example" : null
                      },
                      "echeck_type" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "For Authorize.net ACH users only. Indicates the type of eCheck.\n\n* ppd - Payment Authorization is prearranged between the customer and the merchant.\n* web - Payment Authorization obtained from the customer via the internet.\n* ccd - Payment Authorization agreement from the corporate customer is required. Applicable for business_checking account_type.\n",
                        "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.\n",
                        "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.\n\n* `last_name`:(string, max chars=150) The last name of the contact.\n* `company_name`:(string, max chars=250) The company name for the address.\n* `line1`:(string, max chars=180) The first line of the address.\n* `line2`:(string, max chars=180) The second line of the address.\n* `country`:(string) The name of the country for the address.\n* `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.\n* `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.\n* `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`).\n* `city`:(string, max chars=50) The city name for the address.\n* `postal_code`:(string, max chars=20) The postal or ZIP code for the address.\n* `phone`:(string, max chars=50) The contact phone number for the address.\n* `email`:(string, max chars=70) The contact email address for the address.\n",
                        "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\n"
                    },
                    "payment_source" : {
                      "$ref" : "#/components/schemas/PaymentSource",
                      "description" : "Resource object representing payment_source\n"
                    }
                  },
                  "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.\n\n* For GoCardless, Chargebee supports (ACH,BACS,SEPA,AUTOGIRO,BECS,BECS_NZ,PAD).\n* For Stripe, Chargebee only supports SEPA.\n\nThe API is only supported for the `payment_method` of type `direct_debit`.\n",
        "operationId" : "update_a_bank_account_payment_source",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "cust-payment-source-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/cust-payment-source-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "bank_account" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for bank_account\n",
                    "properties" : {
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Account holder's first name as per bank account.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Account holder's last name as per bank account.\n",
                        "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.\n",
                        "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\n"
                    },
                    "payment_source" : {
                      "$ref" : "#/components/schemas/PaymentSource",
                      "description" : "Resource object representing payment_source\n"
                    }
                  },
                  "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" : "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.\n",
        "operationId" : "local_delete_a_virtual_bank_account",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "virtual-bank-account-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/virtual-bank-account-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "virtual_bank_account" : {
                      "$ref" : "#/components/schemas/VirtualBankAccount",
                      "description" : "Resource object representing virtual_bank_account\n"
                    }
                  },
                  "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.\n",
        "operationId" : "delete_a_virtual_bank_account",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "virtual-bank-account-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/virtual-bank-account-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "virtual_bank_account" : {
                      "$ref" : "#/components/schemas/VirtualBankAccount",
                      "description" : "Resource object representing virtual_bank_account\n"
                    }
                  },
                  "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.\n",
        "operationId" : "list_virtual_bank_accounts",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "limit",
          "in" : "query",
          "description" : "The number of resources to be returned.\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`\nto the value of `next_offset`\nobtained in the previous iteration of the API call.\n",
          "required" : false,
          "deprecated" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "maxLength" : 1000,
            "example" : null
          }
        }, {
          "name" : "customer_id",
          "in" : "query",
          "description" : "optional, string filter\n\nIdentifier of the customer.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*customer_id\\[is\\] = \"3bdjnDnsdQn\"*\n",
          "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\n\nTimestamp indicating when this virtual bank account resource was last updated.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*updated_at\\[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" : "created_at",
          "in" : "query",
          "description" : "optional, timestamp(UTC) in seconds filter\n\nTimestamp indicating when this virtual bank account resource is created.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*created_at\\[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
              }
            }
          }
        } ],
        "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`.\n",
                      "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
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "customer_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Identifier of the customer.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "email" : {
                    "type" : "string",
                    "format" : "email",
                    "deprecated" : false,
                    "description" : "Email address associated with the virtual bank account.\n",
                    "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/1.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\n"
                    },
                    "customer" : {
                      "$ref" : "#/components/schemas/Customer",
                      "description" : "Resource object representing customer\n"
                    }
                  },
                  "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.\n",
        "operationId" : "retrieve_a_virtual_bank_account",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "virtual-bank-account-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/virtual-bank-account-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "virtual_bank_account" : {
                      "$ref" : "#/components/schemas/VirtualBankAccount",
                      "description" : "Resource object representing virtual_bank_account\n"
                    }
                  },
                  "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 using the identifier provided by the gateway.  \nCustomer's email and virtual bank accounts will always be in sync. Email ID specified for virtual bank account creation will be considered over customers' email ID.\n",
        "operationId" : "create_a_virtual_bank_account_using_permanent_token",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "customer_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Identifier of the customer.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "reference_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Identifier provided by the gateway for the virtual bank account source. In case of Stripe, the reference_id consists of a combination of Stripe Customer ID and Stripe Source ID separated by a forward slash (e.g. cus_63MnDn0t6kfDW7/src_6WjCF20vT9WN1G).\n",
                    "maxLength" : 150,
                    "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/1.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", "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\n"
                    },
                    "customer" : {
                      "$ref" : "#/components/schemas/Customer",
                      "description" : "Resource object representing customer\n"
                    }
                  },
                  "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)\nto perform those actions.\n",
        "operationId" : "copy_card",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "customer-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/customer-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "gateway_account_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The gateway account you want to copy the card.\n",
                    "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\n"
                    }
                  },
                  "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\n\nThis operation is obsoleted by the [Retrieve a payment source API](/docs/api/payment_sources/retrieve-a-payment-source)\n.\n\nRetrieves the credit card for the customer id.\n",
        "operationId" : "retrieve_card_for_a_customer",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "customer-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/customer-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "card" : {
                      "$ref" : "#/components/schemas/Card",
                      "description" : "Resource object representing card\n"
                    }
                  },
                  "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)\nto 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" : "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.\n",
                    "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\n"
                    },
                    "card" : {
                      "$ref" : "#/components/schemas/Card",
                      "description" : "Resource object representing card\n"
                    }
                  },
                  "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\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 [Delete a payment source API](/docs/api/payment_sources/delete-a-payment-source)\n.\n\nDeletes 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.\n",
        "operationId" : "delete_card_for_a_customer",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "customer-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/customer-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "customer" : {
                      "$ref" : "#/components/schemas/Customer",
                      "description" : "Resource object representing customer\n"
                    }
                  },
                  "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\n\nThe [Payment Sources API](/docs/api/payment_sources)\n, with its additional options and improvements, obsoletes the [Cards APIs](/docs/api/cards)\n. This operation is obsoleted by the following:\n\n* [Create using temporary token](/docs/api/v2/pcv-1/payment_sources/create-using-gateway-temporary-token)\n* [Create using permanent token](/docs/api/payment_sources/create-using-permanent-token)\n* [Create a card payment source](/docs/api/payment_sources/create-a-card-payment-source)\n\nAdds or replaces card details of a customer. Updating card details replaces the present payment method.\n\nPassing credit card details to this API involves PCI liability at your end as sensitive card info passes through your servers. If you wish to avoid that, you can use one of the following integration methodologies if applicable\n\n* If you are using Stripe gateway, you can use [Stripe.js](https://stripe.com/docs/stripe.js) with your card update form.\n* If you are using Braintree gateway, you can use [Braintree.js](https://www.braintreepayments.com/docs/javascript) with your card update form.\n* 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.\n* 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.\n* 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.\n\n**Legacy behavior:**\n\n* **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.\n* **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.\n",
        "operationId" : "update_card_for_a_customer",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "customer-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/customer-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "gateway_account_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The gateway account in which this payment source is stored.\n",
                    "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.\n**Note:**\nSupported 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).\n",
                    "maxLength" : 300,
                    "example" : null
                  },
                  "first_name" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Cardholder's first name.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "last_name" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Cardholder's last name.\n",
                    "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)\n, 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.\n",
                    "maximum" : 12,
                    "minimum" : 1,
                    "example" : null
                  },
                  "expiry_year" : {
                    "type" : "integer",
                    "format" : "int32",
                    "deprecated" : false,
                    "description" : "Card expiry year.\n",
                    "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)\n, you can specify the Braintree encrypted CVV here.\n",
                    "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.\n",
                    "maxLength" : 150,
                    "example" : null
                  },
                  "billing_addr2" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Address line 2, as available in card billing address.\n",
                    "maxLength" : 150,
                    "example" : null
                  },
                  "billing_city" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "City, as available in card billing address.\n",
                    "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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `billing_state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                    "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`\nis provided.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "billing_zip" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Postal or Zip code, as available in card billing address.\n",
                    "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\n"
                    },
                    "card" : {
                      "$ref" : "#/components/schemas/Card",
                      "description" : "Resource object representing card\n"
                    }
                  },
                  "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\n",
        "operationId" : "retrieve_a_promotional_credit",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "account-credit-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/account-credit-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "promotional_credit" : {
                      "$ref" : "#/components/schemas/PromotionalCredit",
                      "description" : "Resource object representing promotional_credit\n"
                    }
                  },
                  "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\n",
        "operationId" : "list_promotional_credits",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "limit",
          "in" : "query",
          "description" : "The number of resources to be returned.\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`\nto the value of `next_offset`\nobtained in the previous iteration of the API call.\n",
          "required" : false,
          "deprecated" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "maxLength" : 1000,
            "example" : null
          }
        }, {
          "name" : "id",
          "in" : "query",
          "description" : "optional, string filter\n\nUnique reference ID provided for promotional credits.\n**Supported operators :**\nis, is_not, starts_with\n\n**Example →**\n*id\\[is\\] = \"1bkfc8dw2o\"*\n",
          "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\n\nTimestamp indicating when this promotional credit resource is created.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*created_at\\[on\\] = \"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" : "type",
          "in" : "query",
          "description" : "optional, enumerated string filter\n\nType of promotional credits. Possible values are : increment, decrement.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*type\\[is\\] = \"increment\"*\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "example" : "increment",
            "properties" : {
              "is" : {
                "type" : "string",
                "description" : "* `increment` - Increment\n* `decrement` - Decrement",
                "enum" : [ "increment", "decrement" ],
                "example" : null
              },
              "is_not" : {
                "type" : "string",
                "description" : "* `increment` - Increment\n* `decrement` - Decrement",
                "enum" : [ "increment", "decrement" ],
                "example" : null
              },
              "in" : {
                "type" : "string",
                "description" : "* `increment` - Increment\n* `decrement` - Decrement",
                "enum" : [ "increment", "decrement" ],
                "pattern" : "^\\[(increment|decrement)(,(increment|decrement))*\\]$",
                "example" : null
              },
              "not_in" : {
                "type" : "string",
                "description" : "* `increment` - Increment\n* `decrement` - Decrement",
                "enum" : [ "increment", "decrement" ],
                "pattern" : "^\\[(increment|decrement)(,(increment|decrement))*\\]$",
                "example" : null
              }
            }
          }
        }, {
          "name" : "customer_id",
          "in" : "query",
          "description" : "optional, string filter\n\nIdentifier of the customer.\n**Supported operators :**\nis, is_not, starts_with\n\n**Example →**\n*customer_id\\[is\\] = \"4gkYnd21ouvW\"*\n",
          "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`.\n",
                      "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).\n\nFor 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.\n\nIf you do not pass any amount as the input parameter then, it will deduct the whole available amount from the credit balance.\n",
        "operationId" : "deduct_promotional_credits",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "customer_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Identifier of the customer.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "amount" : {
                    "type" : "integer",
                    "format" : "int64",
                    "deprecated" : false,
                    "description" : "Promotional credits amount.\n",
                    "minimum" : 0,
                    "example" : null
                  },
                  "amount_in_decimal" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Amount in decimal.\n",
                    "maxLength" : 33,
                    "example" : null
                  },
                  "currency_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The currency code (ISO 4217 format) for promotional credit.\n",
                    "maxLength" : 3,
                    "example" : null
                  },
                  "description" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Detailed description of this promotional credits.\n",
                    "maxLength" : 250,
                    "example" : null
                  },
                  "credit_type" : {
                    "type" : "string",
                    "default" : "general",
                    "deprecated" : false,
                    "description" : "Type of promotional credits provided to customer.\n\n* general - General\n* referral_rewards - Referral\n* loyalty_credits - Loyalty Credits\n",
                    "enum" : [ "loyalty_credits", "referral_rewards", "general" ],
                    "example" : null
                  },
                  "reference" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Describes why promotional credits were provided.\n",
                    "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\n"
                    },
                    "promotional_credit" : {
                      "$ref" : "#/components/schemas/PromotionalCredit",
                      "description" : "Resource object representing promotional_credit\n"
                    }
                  },
                  "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).\n\nFor example,\n\n* 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.\n* 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.\n* 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.\n",
        "operationId" : "set_promotional_credits",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "customer_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Identifier of the customer.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "amount" : {
                    "type" : "integer",
                    "format" : "int64",
                    "deprecated" : false,
                    "description" : "Promotional credits amount.\n",
                    "minimum" : 0,
                    "example" : null
                  },
                  "amount_in_decimal" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Amount in decimal.\n",
                    "maxLength" : 33,
                    "example" : null
                  },
                  "currency_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The currency code (ISO 4217 format) for promotional credit.\n",
                    "maxLength" : 3,
                    "example" : null
                  },
                  "description" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Detailed description of this promotional credits.\n",
                    "maxLength" : 250,
                    "example" : null
                  },
                  "credit_type" : {
                    "type" : "string",
                    "default" : "general",
                    "deprecated" : false,
                    "description" : "Type of promotional credits provided to customer.\n\n* general - General\n* referral_rewards - Referral\n* loyalty_credits - Loyalty Credits\n",
                    "enum" : [ "loyalty_credits", "referral_rewards", "general" ],
                    "example" : null
                  },
                  "reference" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Describes why promotional credits were provided.\n",
                    "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\n"
                    },
                    "promotional_credit" : {
                      "$ref" : "#/components/schemas/PromotionalCredit",
                      "description" : "Resource object representing promotional_credit\n"
                    }
                  },
                  "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).\n\nFor example, if a customer has credits of $10, if you pass the **amount** as $10, then the customer's credit balance would become $20.\n",
        "operationId" : "add_promotional_credits",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "customer_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Identifier of the customer.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "amount" : {
                    "type" : "integer",
                    "format" : "int64",
                    "deprecated" : false,
                    "description" : "Promotional credits amount.\n",
                    "minimum" : 0,
                    "example" : null
                  },
                  "amount_in_decimal" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Amount in decimal.\n",
                    "maxLength" : 33,
                    "example" : null
                  },
                  "currency_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The currency code (ISO 4217 format) for promotional credit.\n",
                    "maxLength" : 3,
                    "example" : null
                  },
                  "description" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Detailed description of this promotional credits.\n",
                    "maxLength" : 250,
                    "example" : null
                  },
                  "credit_type" : {
                    "type" : "string",
                    "default" : "general",
                    "deprecated" : false,
                    "description" : "Type of promotional credits provided to customer.\n\n* general - General\n* referral_rewards - Referral\n* loyalty_credits - Loyalty Credits\n",
                    "enum" : [ "loyalty_credits", "referral_rewards", "general" ],
                    "example" : null
                  },
                  "reference" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Describes why promotional credits were provided.\n",
                    "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\n"
                    },
                    "promotional_credit" : {
                      "$ref" : "#/components/schemas/PromotionalCredit",
                      "description" : "Resource object representing promotional_credit\n"
                    }
                  },
                  "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" : "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.\n",
            "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.\n",
        "operationId" : "delete_line_items",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "invoice-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/invoice-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "line_items" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "The list of line items which have to be deleted.\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "Uniquely identifies a line_item\n",
                        "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\n"
                    }
                  },
                  "required" : [ "invoice" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/invoices/charge_addon" : {
      "post" : {
        "tags" : [ "invoices" ],
        "summary" : "Create invoice for a non-recurring addon",
        "description" : "Generate invoices for a non-recurring addon using this API.\n",
        "operationId" : "create_invoice_for_a_non-recurring_addon",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "customer_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Identifier of the customer for which this invoice needs to be created. Should be specified if 'subscription_id' is not specified.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "subscription_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Identifier of the subscription for which this invoice(not applicable for consolidated invoice) needs to be created. Should be specified if 'customer_id' is not specified.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "addon_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The ID of the non-recurring addon to be charged.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "addon_quantity" : {
                    "type" : "integer",
                    "format" : "int32",
                    "deprecated" : false,
                    "description" : "The number of addon units to be charged. Mandatory for quantity based addons.\n",
                    "minimum" : 1,
                    "example" : null
                  },
                  "addon_unit_price" : {
                    "type" : "integer",
                    "format" : "int64",
                    "deprecated" : false,
                    "description" : "Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                    "minimum" : 0,
                    "example" : null
                  },
                  "addon_quantity_in_decimal" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The number of addon units to be charged in decimal.\n",
                    "maxLength" : 33,
                    "example" : null
                  },
                  "addon_unit_price_in_decimal" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Addon Amount in Decimal.\n",
                    "maxLength" : 39,
                    "example" : null
                  },
                  "date_from" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "The time when the service period for the addon starts.\n",
                    "example" : null
                  },
                  "date_to" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "The time when the service period for the addon ends.\n",
                    "example" : null
                  },
                  "coupon_ids" : {
                    "type" : "array",
                    "deprecated" : false,
                    "description" : "List of Coupons to be added.\n",
                    "items" : {
                      "type" : "string",
                      "deprecated" : false,
                      "maxLength" : 100,
                      "example" : null
                    },
                    "example" : null
                  },
                  "po_number" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Purchase Order Number for this invoice.\n",
                    "maxLength" : 100,
                    "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.\n`taxes`\nand\n`line_item_taxes`\nare 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.\n",
                    "example" : null
                  },
                  "payment_source_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Payment source to be used for this payment.\n",
                    "maxLength" : 40,
                    "example" : null
                  },
                  "payment_initiator" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The type of initiator to be used for the payment request triggered by this operation.\n\n* merchant - Pass this value to indicate that the request is initiated by the merchant\n* customer - Pass this value to indicate that the request is initiated by the customer\n",
                    "enum" : [ "customer", "merchant" ],
                    "example" : null
                  }
                },
                "required" : [ "addon_id" ],
                "example" : null
              },
              "encoding" : { }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "invoice" : {
                      "$ref" : "#/components/schemas/Invoice",
                      "description" : "Resource object representing invoice\n"
                    }
                  },
                  "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" : "This API removes a credit note attached to an invoice. When you remove a credit note from an invoice, the invoice status returns to `not_paid`.  \n**Note:**\nYou cannot remove a credit note from an invoice if it has already been refunded.\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" : "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\n",
                    "properties" : {
                      "id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Credit-note id.\n",
                        "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\n"
                    },
                    "credit_note" : {
                      "$ref" : "#/components/schemas/CreditNote",
                      "description" : "Resource object representing credit_note\n"
                    }
                  },
                  "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" : "This API [removes payments](https://www.chargebee.com/docs/2.0/invoice-operations.html#actions-for-paid-invoices_remove-payment) applied to an invoice. Once the applied payment is removed, the invoice status returns to `not_paid` or `payment_due`. The removed payment is then added to the customer's excess payment balance.\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" : "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\n",
                    "properties" : {
                      "id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Uniquely identifies the transaction.\n",
                        "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\n"
                    },
                    "transaction" : {
                      "$ref" : "#/components/schemas/Transaction",
                      "description" : "Resource object representing transaction\n"
                    }
                  },
                  "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\".\n",
        "operationId" : "stop_dunning_for_invoice",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "invoice-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/invoice-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "comment" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "An internal [comment](/docs/api/comments)\nto 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)\nor any document such as the [Invoice PDF](/docs/api/invoices/retrieve-invoice-as-pdf)\n.\n",
                    "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\n"
                    }
                  },
                  "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" : "The API applies [excess payments](/docs/api/customers/customer-object#excess_payments) to an invoice. Once an excess payment is applied, the [invoice.amount_due](/docs/api/invoices/invoice-object#amount_due) is recalculated. The invoice `status` changes to either `paid` or `payment_due` depending on how much excess payment is applied to the invoice amount.\n\nFor example, if you have an excess payment of $25.00, and the invoice to which you want to apply this excess payment has a balance of $50. Once you apply this excess payment, the invoice status changes to `paid`, and [invoice.amount_due](/docs/api/invoices/invoice-object#amount_due) is adjusted to $25.00.\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" : "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)\nto 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)\nor any document such as the [Invoice PDF](/docs/api/invoices/retrieve-invoice-as-pdf)\n.\n",
                    "maxLength" : 300,
                    "example" : null
                  },
                  "transactions" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for transactions\n",
                    "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.\n",
                        "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)\n, or [invoice.amount_due](/docs/api/invoices/invoice-object#amount_due)\n.\n",
                        "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\n"
                    }
                  },
                  "required" : [ "invoice" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/invoices/{invoice-id}/add_addon_charge" : {
      "post" : {
        "tags" : [ "invoices" ],
        "summary" : "Add non-recurring addon to a pending invoice",
        "description" : "Add non-recurring addon to a pending invoice.\n",
        "operationId" : "add_non-recurring_addon_to_a_pending_invoice",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "invoice-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/invoice-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "addon_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The ID of the non-recurring addon to be charged.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "addon_quantity" : {
                    "type" : "integer",
                    "format" : "int32",
                    "deprecated" : false,
                    "description" : "The number of addon units to be charged. Mandatory for quantity based addons.\n",
                    "minimum" : 1,
                    "example" : null
                  },
                  "addon_unit_price" : {
                    "type" : "integer",
                    "format" : "int64",
                    "deprecated" : false,
                    "description" : "Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                    "minimum" : 0,
                    "example" : null
                  },
                  "addon_quantity_in_decimal" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The decimal representation of the quantity of the [non-recurring addon](https://www.chargebee.com/docs/charges.html#non-recurring-addon ).\nProvide the value in major units of the currency. Must be provided when the addon is quantity-based. This parameter can only be passed when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                    "maxLength" : 33,
                    "example" : null
                  },
                  "addon_unit_price_in_decimal" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "When [price overriding](http://chargebee.com/docs/price-override.html )\nis enabled for the site, the price or per-unit price of the [non-recurring addon](https://www.chargebee.com/docs/charges.html#non-recurring-addon )\ncan be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)\nis used by default. Provide the value as a decimal string in major units of the currency. This parameter can only be passed when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                    "maxLength" : 39,
                    "example" : null
                  },
                  "comment" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "An internal [comment](/docs/api/comments)\nto 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)\nor any document such as the [Invoice PDF](/docs/api/invoices/retrieve-invoice-as-pdf)\n.\n",
                    "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.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "line_item" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for line_item\n",
                    "properties" : {
                      "date_from" : {
                        "type" : "integer",
                        "format" : "unix-time",
                        "deprecated" : false,
                        "description" : "The time when the service period for the addon starts.\n",
                        "example" : null
                      },
                      "date_to" : {
                        "type" : "integer",
                        "format" : "unix-time",
                        "deprecated" : false,
                        "description" : "The time when the service period for the addon ends.\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  }
                },
                "required" : [ "addon_id" ],
                "example" : null
              },
              "encoding" : {
                "line_item" : {
                  "style" : "deepObject",
                  "explode" : true
                }
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "invoice" : {
                      "$ref" : "#/components/schemas/Invoice",
                      "description" : "Resource object representing invoice\n"
                    }
                  },
                  "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. Any payments must be [removed](/docs/api/invoices/remove-payment-from-an-invoice) from the invoice before voiding it.\n\n* Any [promotional credits](/docs/api/promotional_credits) or [credit notes](/docs/api/credit_notes) applied to the invoice are removed.\n* If an invoice for the current term of a subscription is voided and the subscription is changed later with `proration` enabled, no prorated credits are issued.\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" : "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)\nto 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)\nor any document such as the [Invoice PDF](/docs/api/invoices/retrieve-invoice-as-pdf)\n.\n",
                    "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**.\nMust be passed if set as mandatory in the app. The codes are case-sensitive.\n",
                    "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\n"
                    },
                    "credit_note" : {
                      "$ref" : "#/components/schemas/CreditNote",
                      "description" : "Resource object representing credit_note\n"
                    }
                  },
                  "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 [plan](/docs/api/v2/pcv-1/plans) or [addon](/docs/api/v2/pcv-1/addons). 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`.\n",
        "operationId" : "add_one-time_charge_to_a_pending_invoice",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "invoice-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/invoice-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "amount" : {
                    "type" : "integer",
                    "format" : "int64",
                    "deprecated" : false,
                    "description" : "The amount to be charged. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                    "minimum" : 1,
                    "example" : null
                  },
                  "description" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Detailed description about this lineitem.\n",
                    "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)\nintegration.\n\n* retail - Transaction is a sale to an end user\n* wholesale - Transaction is a sale to another company that will resell your product or service to another consumer\n* vendor_use - Transaction is for an item that is subject to vendor use tax\n* consumed - Transaction is for an item that is consumed directly\n",
                    "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)\nintegration.\n",
                    "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)\nintegration.\n",
                    "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)\n.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "hsn_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The [HSN code](https://cbic-gst.gov.in/gst-goods-services-rates.html)\nto which the one-time charge is mapped for calculating the customer's tax in India. Applicable when both the conditions are true:\n\n* [**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.)\n* The [**AvaTax for Sales** integration](https://www.chargebee.com/docs/avalara.html) has been enabled in Chargebee. .\n",
                    "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)\n.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "comment" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "An internal [comment](/docs/api/comments)\nto 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)\nor any document such as the [Invoice PDF](/docs/api/invoices/retrieve-invoice-as-pdf)\n.\n",
                    "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.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "line_item" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for line_item\n",
                    "properties" : {
                      "date_from" : {
                        "type" : "integer",
                        "format" : "unix-time",
                        "deprecated" : false,
                        "description" : "The time when the service period for the charge starts.\n",
                        "example" : null
                      },
                      "date_to" : {
                        "type" : "integer",
                        "format" : "unix-time",
                        "deprecated" : false,
                        "description" : "The time when the service period for the charge ends.\n",
                        "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\n"
                    }
                  },
                  "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.\nTo support cases like TDS and invoice edits, we need to stop auto e-invoice sending and be able to send e-invoices manually.\nThis endpoint schedules e-invoices manually. This operation is not allowed when any of the following condition matches:\n\n* If e-invoicing is not enabled at the site and customer level.\n\n* If there is an e-invoice generated already for the invoice.\n\n* If the **Use automatic e-invoicing** option is selected.\n\n* If there are no generated e-invoices with the `failed` or `skipped` status.\n\n* If the invoice status is `voided` or `pending`.\n\n",
        "operationId" : "send_an_einvoice_for_invoices",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "invoice-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/invoice-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : { },
                "example" : null
              },
              "encoding" : { }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "invoice" : {
                      "$ref" : "#/components/schemas/Invoice",
                      "description" : "Resource object representing invoice\n"
                    }
                  },
                  "required" : [ "invoice" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/invoices/{invoice-id}/write_off" : {
      "post" : {
        "tags" : [ "invoices" ],
        "summary" : "Write off an invoice",
        "description" : "This API writes off an Invoice.\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" : "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.\n",
                    "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\n"
                    },
                    "credit_note" : {
                      "$ref" : "#/components/schemas/CreditNote",
                      "description" : "Resource object representing credit_note\n"
                    }
                  },
                  "required" : [ "credit_note", "invoice" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/invoices/{invoice-id}/pause_dunning" : {
      "post" : {
        "tags" : [ "invoices" ],
        "summary" : "Pause dunning for invoice",
        "description" : "Pause [dunning](https://www.chargebee.com/docs/payments/1.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/1.0/dunning-v2.html) and dunning [email notifications](https://www.chargebee.com/docs/payments/1.0/dunning-v2.html#dunning-email-notifications) for the invoice until `expected_payment_date`.\n\n#### Prerequisites\n\nThis operation is only permitted for an invoice that meets *all* the following conditions:\n\n* The [status](/docs/api/v2/pcv-1/invoices/invoice-object#status) of the invoice is `payment_due`.\n* The invoice belongs to a [subscription](/docs/api/v2/pcv-1/subscriptions) or [customer](/docs/api/v2/pcv-1/customers) with [`auto_collection`](/docs/api/v2/pcv-1/subscriptions/subscription-object#auto_collection) set to `on`.\n* The invoice does not have dunning paused currently.\n\n#### Automatic dunning resumption {#dunning_resume_process}\n\nUnless you [resume dunning](/docs/api/v2/pcv-1/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:\n\n* 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.\n* If the `expected_payment_date` is after the dunning period for the invoice, the [final action](https://www.chargebee.com/docs/payments/1.0/dunning-v2.html) configured in Billing is initiated for the invoice and, if applicable, for the subscription.\n",
        "operationId" : "pause_dunning_for_invoice",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "invoice-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/invoice-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "expected_payment_date" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "The date and time at which dunning should resume.\n**See also** : [Dunning resumption process](/docs/api/v2/pcv-1/invoices/resume-dunning-for-invoice).\n",
                    "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.\n**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).\n",
                    "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\n"
                    }
                  },
                  "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" : "**Important**\n\nFor sites where both [legacy and latest](/docs/api/v2/pcv-1/upgrade#retrieving-api-responses-in-latest-api-format) product catalog versions are active, GET API requests return responses in a `compat` format by default. This format works with both latest and legacy Product Catalog.\n\n**Override options:**\n\n* `chargebee-response-schema-type: items` → Return response in latest product catalog format only.\n* `chargebee-response-schema-type: plans_addons` → Return response in legacy product catalog format only.\n\nLists all the Invoices.\n",
        "operationId" : "list_invoices",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "limit",
          "in" : "query",
          "description" : "The number of resources to be returned.\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`\nto the value of `next_offset`\nobtained in the previous iteration of the API call.\n",
          "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**\n' attribute will be '**true**\n'.\n",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "boolean",
            "default" : false,
            "example" : null
          }
        }, {
          "name" : "id",
          "in" : "query",
          "description" : "optional, string filter\n\nThe invoice number. Acts as a identifier for invoice and typically generated sequentially.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*id\\[is\\] = \"INVOICE_654\"*\n",
          "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\n\nTo filter based on subscription_id.\nNOTE: Not to be used if *consolidated invoicing*\nis enabled.\n**Supported operators :**\nis, is_not, starts_with, is_present, in, not_in\n\n**Example →**\n*subscription_id\\[is\\] = \"3bdjnDnsdQn\"*\n",
          "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\n\nThe identifier of the customer this invoice belongs to.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*customer_id\\[is_not\\] = \"3bdjnDnsdQn\"*\n",
          "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\n\nBoolean indicating whether this invoice belongs to a subscription. Possible values are : *true, false*\n\n**Supported operators :**\nis\n\n**Example →**\n*recurring\\[is\\] = \"true\"*\n",
          "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\n\nCurrent status of this invoice. Possible values are : paid, posted, payment_due, not_paid, voided, pending.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*status\\[is_not\\] = \"paid\"*\n",
          "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\n\nThe price type of the invoice. Possible values are : tax_exclusive, tax_inclusive.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*price_type\\[is\\] = \"tax_exclusive\"*\n",
          "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.\n* `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.\n* `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.\n* `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.\n* `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\n\nThe document date displayed on the invoice PDF.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*date\\[after\\] = \"1394532759\"*\n",
          "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\n\nTimestamp indicating the date \\& time this invoice got paid.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*paid_at\\[before\\] = \"1394532759\"*\n",
          "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\n\nInvoiced 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.\n**Supported operators :**\nis, is_not, lt, lte, gt, gte, between\n\n**Example →**\n*total\\[is\\] = \"1000\"*\n",
          "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\n\nPayments collected successfully for the invoice. This is the sum of [linked_payments[]](/docs/api/invoices/invoice-object#linked_payments)`.txn_amount`\nfor all `linked_payments[]`\nthat have `txn_status`\nas `success`.\n**Supported operators :**\nis, is_not, lt, lte, gt, gte, between\n\n**Example →**\n*amount_paid\\[is\\] = \"800\"*\n",
          "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\n\nTotal adjustments made against this invoice.\n**Supported operators :**\nis, is_not, lt, lte, gt, gte, between\n\n**Example →**\n*amount_adjusted\\[is\\] = \"100\"*\n",
          "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\n\nTotal credits applied against this invoice.\n**Supported operators :**\nis, is_not, lt, lte, gt, gte, between\n\n**Example →**\n*credits_applied\\[is\\] = \"100\"*\n",
          "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\n\nThe unpaid amount that is due on the invoice. This is calculated as: [total](/docs/api/invoices/invoice-object#total)\n\n* [amount_paid](/docs/api/invoices/invoice-object#amount_paid)\n* sum of [applied_credits](/docs/api/invoices/invoice-object#applied_credits)`.applied_amount`\n* sum of [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)`.cn_total`\n* sum of [linked_taxes_withheld](/docs/api/invoices/invoice-object#linked_taxes_withheld)`.amount`. **Supported operators :** is, is_not, lt, lte, gt, gte, between\n\n**Example →**\n*amount_due\\[is_not\\] = \"200\"*\n",
          "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\n\nCurrent dunning status of the invoice. Possible values are : in_progress, exhausted, stopped, success.\n\n**Supported operators :**\nis, is_not, in, not_in, is_present\n\n**Example →**\n*dunning_status\\[is\\] = \"in_progress\"*\n",
          "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.\n* `exhausted` - Maximum number of attempts have been made.\n* `stopped` - Dunning has stopped for this invoice.\n* `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.\n* `exhausted` - Maximum number of attempts have been made.\n* `stopped` - Dunning has stopped for this invoice.\n* `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.\n* `exhausted` - Maximum number of attempts have been made.\n* `stopped` - Dunning has stopped for this invoice.\n* `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.\n* `exhausted` - Maximum number of attempts have been made.\n* `stopped` - Dunning has stopped for this invoice.\n* `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\n\nPayment owner of an invoice.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*payment_owner\\[is\\] = \"payment_customer\"*\n",
          "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\n\nTo filter based on `updated_at`.\nThis 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`\ninput parameter as `updated_at`\nfor a faster response.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*updated_at\\[on\\] = \"1243545465\"*\n",
          "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\n\nThe subscription channel this object originated from and is maintained in. Possible values are : web, app_store, play_store.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*channel\\[is\\] = \"APP STORE\"*\n",
          "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\n\nTimestamp indicating the date \\& time this invoice got voided.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*voided_at\\[before\\] = \"1394532759\"*\n",
          "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\n\nReason 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** .\nMust be passed if set as mandatory in the app. The codes are case-sensitive.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*void_reason_code\\[is\\] = \"Other\"*\n",
          "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\n\nSorts based on the specified attribute.\n**Supported attributes :**\ndate, updated_at\n\n**Supported sort-orders :**\nasc, desc\n\n**Example →**\n*sort_by\\[asc\\] = \"date\"*\n\nThis will sort the result based on the 'date' attribute in ascending(earliest first) order.\n",
          "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\n",
          "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`\n, see `message`\n.\n",
                "example" : "failed",
                "properties" : {
                  "is" : {
                    "type" : "string",
                    "description" : "* `scheduled` - Sending the e-invoice to the customer has been scheduled.\n* `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.\n* `in_progress` - The e-invoice has been sent and Chargebee is waiting for confirmation from the receiving entity.\n* `success` - The e-invoice has been successfully delivered to the customer.\n* `failed` - The e-invoice was sent and there was an error due to which it was not delivered.\n* `registered` - The e-invoice was sent and there was an error due to which it was not delivered but got cleared in the IRP.\n* `accepted` - The e-invoice was sent and it was accepted by the receiving entity. The sending entity shall also accept the e-invoice.\n* `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.\n* `message_acknowledgement` - An acknowledgment confirming that the application response was successfully received by the receiving entity.\n* `in_process` - The e-invoice is currently being processed by the receiving entity.\n* `under_query` - The receiving entity has raised a query regarding the e-invoice. Additional information or clarification is required before proceeding.\n* `conditionally_accepted` - The e-invoice has been accepted with conditions.\n* `paid` - The receiving entity has confirmed that the e-invoice has been paid.\n",
                    "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.\n* `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.\n* `in_progress` - The e-invoice has been sent and Chargebee is waiting for confirmation from the receiving entity.\n* `success` - The e-invoice has been successfully delivered to the customer.\n* `failed` - The e-invoice was sent and there was an error due to which it was not delivered.\n* `registered` - The e-invoice was sent and there was an error due to which it was not delivered but got cleared in the IRP.\n* `accepted` - The e-invoice was sent and it was accepted by the receiving entity. The sending entity shall also accept the e-invoice.\n* `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.\n* `message_acknowledgement` - An acknowledgment confirming that the application response was successfully received by the receiving entity.\n* `in_process` - The e-invoice is currently being processed by the receiving entity.\n* `under_query` - The receiving entity has raised a query regarding the e-invoice. Additional information or clarification is required before proceeding.\n* `conditionally_accepted` - The e-invoice has been accepted with conditions.\n* `paid` - The receiving entity has confirmed that the e-invoice has been paid.\n",
                    "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.\n* `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.\n* `in_progress` - The e-invoice has been sent and Chargebee is waiting for confirmation from the receiving entity.\n* `success` - The e-invoice has been successfully delivered to the customer.\n* `failed` - The e-invoice was sent and there was an error due to which it was not delivered.\n* `registered` - The e-invoice was sent and there was an error due to which it was not delivered but got cleared in the IRP.\n* `accepted` - The e-invoice was sent and it was accepted by the receiving entity. The sending entity shall also accept the e-invoice.\n* `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.\n* `message_acknowledgement` - An acknowledgment confirming that the application response was successfully received by the receiving entity.\n* `in_process` - The e-invoice is currently being processed by the receiving entity.\n* `under_query` - The receiving entity has raised a query regarding the e-invoice. Additional information or clarification is required before proceeding.\n* `conditionally_accepted` - The e-invoice has been accepted with conditions.\n* `paid` - The receiving entity has confirmed that the e-invoice has been paid.\n",
                    "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.\n* `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.\n* `in_progress` - The e-invoice has been sent and Chargebee is waiting for confirmation from the receiving entity.\n* `success` - The e-invoice has been successfully delivered to the customer.\n* `failed` - The e-invoice was sent and there was an error due to which it was not delivered.\n* `registered` - The e-invoice was sent and there was an error due to which it was not delivered but got cleared in the IRP.\n* `accepted` - The e-invoice was sent and it was accepted by the receiving entity. The sending entity shall also accept the e-invoice.\n* `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.\n* `message_acknowledgement` - An acknowledgment confirming that the application response was successfully received by the receiving entity.\n* `in_process` - The e-invoice is currently being processed by the receiving entity.\n* `under_query` - The receiving entity has raised a query regarding the e-invoice. Additional information or clarification is required before proceeding.\n* `conditionally_accepted` - The e-invoice has been accepted with conditions.\n* `paid` - The receiving entity has confirmed that the e-invoice has been paid.\n",
                    "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`.\n",
                      "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" : [ "invoices" ],
        "summary" : "Create an invoice",
        "description" : "**Note:**\nThis operation optionally supports 3DS verification flow. To achieve the same, create the [Payment Intent](/docs/api/getting-started)\nand pass it as input parameter to this API.\n\nCreates a one-off invoice for multiple 'Non Recurring' add-on \\& ad-hoc charges for a customer.\n\nIf the 'auto collection' has been turned 'on' for that customer then payment will be immediately collected using the payment method associated with the customer. The invoice will be generated upon successful collection of payments.\n\nHowever, if the 'auto collection' is turned 'off', no collection attempt will be made and the invoice will be generated in the \"Payment Due\" status. Customer level auto collection property can be overridden by passing the auto_collection parameter.\n\nThe Shipping Address can be passed, which will then be attached to the generated invoice.\n\nA 'One Time' coupon can be explicitly specified while creating this invoice.\n\nYou can pass the authorization_transaction_id to capture the already blocked funds to collect the payment. The excess payments will be applied to the invoice followed by the captured authorization payment.\n\nIf capturing authorization fails, the invoice will not be created. The invoice creation can be retried by passing the auto-collection as OFF. If the invoice due amount is greater than the authorization \\& excess payment amount collectively, the invoice status will be returned as **payment_due**. Collect payment for invoice API can be used to collect the remaining amount due.  \n* The authorization transaction will not be captured if the fraud status is found as suspicious. This api will result in invalid_state_for_request error. Read more on [fraud management using Stripe Radar](https://www.chargebee.com/docs/stripe-radar.html).\n* Passing **auto_collection** will not update the customer level property.\n* Available Credits and Excess Payments will automatically be applied to this invoice.\n",
        "operationId" : "create_an_invoice",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "customer_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Identifier of the customer for which this invoice needs to be created. Should be specified if 'subscription_id' is not specified.\n",
                    "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).\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "currency_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The currency code (ISO 4217 format) of the invoice amount.\n",
                    "maxLength" : 3,
                    "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.\n`taxes`\nand\n`line_item_taxes`\nare 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.\n",
                    "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)\nfor the invoice are displayed on the PDF invoice sent to the customer.\n",
                    "maxLength" : 2000,
                    "example" : null
                  },
                  "remove_general_note" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "Set as `true`\nto remove the [**general note**](https://www.chargebee.com/docs/invoice_notes.html#adding-general-notes)\nfrom this invoice.\n",
                    "example" : null
                  },
                  "po_number" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Purchase Order Number for this invoice.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "coupon_ids" : {
                    "type" : "array",
                    "deprecated" : false,
                    "description" : "List of Coupons to be added.\n",
                    "items" : {
                      "type" : "string",
                      "deprecated" : false,
                      "maxLength" : 100,
                      "example" : null
                    },
                    "example" : null
                  },
                  "authorization_transaction_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Authorization transaction to be captured.\n",
                    "maxLength" : 40,
                    "example" : null
                  },
                  "payment_source_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Payment source to be used for this payment.\n",
                    "maxLength" : 40,
                    "example" : null
                  },
                  "auto_collection" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "If specified, the customer level auto collection will be overridden.\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
                  },
                  "token_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Token generated by Chargebee.js representing payment method details.\n",
                    "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.\nIn case of Create Subscription for Customer endpoint, the default value is True. Otherwise, the default value is False.\n",
                    "example" : null
                  },
                  "retain_payment_source" : {
                    "type" : "boolean",
                    "default" : true,
                    "deprecated" : false,
                    "description" : "Indicates whether the payment source should be retained for the customer.\n",
                    "example" : null
                  },
                  "payment_initiator" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The type of initiator to be used for the payment request triggered by this operation.\n\n* customer - Pass this value to indicate that the request is initiated by the customer\n* merchant - Pass this value to indicate that the request is initiated by the merchant\n",
                    "enum" : [ "customer", "merchant" ],
                    "example" : null
                  },
                  "shipping_address" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for shipping_address\n",
                    "properties" : {
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The first name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The last name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "The email address.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "company" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The company name.\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The phone number.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line3" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 3\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "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`\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.\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://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.\n\n* not_validated - Address is not yet validated.\n* valid - Address was validated successfully.\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n",
                        "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "statement_descriptor" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for statement_descriptor\n",
                    "properties" : {
                      "descriptor" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Payment descriptor text\n",
                        "maxLength" : 65000,
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "card" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for card\n",
                    "properties" : {
                      "gateway_account_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The gateway account in which this payment source is stored.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Cardholder's first name\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Cardholder's last name\n",
                        "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)\n, 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.\n",
                        "maximum" : 12,
                        "minimum" : 1,
                        "example" : null
                      },
                      "expiry_year" : {
                        "type" : "integer",
                        "format" : "int32",
                        "deprecated" : false,
                        "description" : "Card expiry year.\n",
                        "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)\n, you can specify the Braintree encrypted CVV here.\n",
                        "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.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "billing_addr2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2, as available in card billing address.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "billing_city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "City, as available in card billing address.\n",
                        "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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `billing_state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "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`\nis provided.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "billing_zip" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Postal or Zip code, as available in card billing address.\n",
                        "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).\n\n  * `payer`: User related information.\n    * `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).\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n    * `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.\n* `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.\n\n  * `fraud`: Fraud identification related information.\n    * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n* `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.\n\n  * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.\n* `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.\n\n  * `payer`: User related information.\n    * `document`: Document is the user's identification number based on their country.\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "bank_account" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for bank_account\n",
                    "properties" : {
                      "gateway_account_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The gateway account in which this payment source is stored.\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)\nplatform, this can be the [local bank details](https://developer.gocardless.com/api-reference/#appendix-local-bank-details)\n",
                        "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.\n",
                        "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.\n",
                        "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.\n",
                        "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.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Phone number of the account holder that is linked to the bank account.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "bank_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Name of account holder's bank.\n",
                        "maxLength" : 100,
                        "example" : null
                      },
                      "account_number" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Account holder's bank account number.\n",
                        "maxLength" : 17,
                        "minLength" : 4,
                        "example" : null
                      },
                      "routing_number" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Bank account routing number.\n",
                        "maxLength" : 9,
                        "minLength" : 3,
                        "example" : null
                      },
                      "bank_code" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Indicates the bank code.\n",
                        "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/)\nACH and Razorpay NetBanking users only. If not passed, account type is taken as null.\n\n* checking - Checking Account\n* business_checking - Business Checking Account\n* savings - Savings Account\n* current - Current Account\n",
                        "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.\n\n* individual - Individual Account.\n* company - Company Account.\n",
                        "enum" : [ "individual", "company" ],
                        "example" : null
                      },
                      "echeck_type" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "For Authorize.net ACH users only. Indicates the type of eCheck.\n\n* ppd - Payment Authorization is prearranged between the customer and the merchant.\n* ccd - Payment Authorization agreement from the corporate customer is required. Applicable for business_checking account_type.\n* web - Payment Authorization obtained from the customer via the internet.\n",
                        "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)\nISO country code. Required when local bank details are provided, and not IBAN.\n",
                        "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.\n",
                        "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.\n\n* `last_name`:(string, max chars=150) The last name of the contact.\n* `company_name`:(string, max chars=250) The company name for the address.\n* `line1`:(string, max chars=180) The first line of the address.\n* `line2`:(string, max chars=180) The second line of the address.\n* `country`:(string) The name of the country for the address.\n* `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.\n* `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.\n* `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`).\n* `city`:(string, max chars=50) The city name for the address.\n* `postal_code`:(string, max chars=20) The postal or ZIP code for the address.\n* `phone`:(string, max chars=50) The contact phone number for the address.\n* `email`:(string, max chars=70) The contact email address for the address.\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "payment_method" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for payment_method\n",
                    "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)\nAPI 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.\n",
                        "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* .\nFor 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:**\nThis is not the one-time temporary token provided by gateways like Stripe.\n\nFor more details refer [Update payment method for a customer](/docs/api/customers/update-payment-method-for-a-customer)\nAPI under Customer resource.\n",
                        "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.\n",
                        "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)\n.\n\n**Note**:\nIf you enter an invalid country code, the system will return an error.\n\nIf you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\nin 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\nthe Brexit configuration, then `XI`\n(the code for **United Kingdom - Northern Ireland**\n) 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).\n\n  * `payer`: User related information.\n    * `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).\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n    * `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.\n* `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.\n\n  * `fraud`: Fraud identification related information.\n    * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n* `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.\n\n  * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.\n* `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.\n\n  * `payer`: User related information.\n    * `document`: Document is the user's identification number based on their country.\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "payment_intent" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for payment_intent\n",
                    "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.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "gateway_account_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The gateway account used for performing the 3DS flow.\n",
                        "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)\nto find out the gateway-specific gw_token format. Applicable when you are using gateway APIs directly for completing the 3DS flow.\n",
                        "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.\n\n* card - card\n* twint - Payments made via Twint\n* dotpay - dotpay\n* 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 -\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 -\n* alipay - Payments made via Alipay.\n* tamara - Payments made via Tamara.\n* pay_to -\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.\n",
                        "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).\n\n  * `payer`: User related information.\n    * `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).\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n    * `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.\n* `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.\n\n  * `fraud`: Fraud identification related information.\n    * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n* `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.\n\n  * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.\n* `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.\n\n  * `payer`: User related information.\n    * `document`: Document is the user's identification number based on their country.\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "Identifier of the addon. Multiple addons can be passed.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "default" : 1,
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price" : {
                        "type" : "array",
                        "description" : "The price or per-unit-price of the addon. The value depends on the [type of currency](/docs/api/getting-started).  \n**Note:**\n\nFor recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the [addon period](/docs/api/v2/pcv-1/addons/addon-object#period). For example, consider the following details:\n\n* The `unit_price` provided is $10\n* The addon billing period is 1 month.\n* The plan billing period is 3 months.\n* The addon is only billed for $10 on each subscription renewal.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_in_decimal" : {
                        "type" : "array",
                        "description" : "The decimal representation of the quantity of the [non-recurring addon](https://www.chargebee.com/docs/charges.html#non-recurring-addon ).\nProvide the value in major units of the currency. Must be provided when the addon is quantity-based. This parameter can only be passed when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 33,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price_in_decimal" : {
                        "type" : "array",
                        "description" : "When [price overriding](http://chargebee.com/docs/price-override.html )\nis enabled for the site, the price or per-unit price of the [non-recurring addon](https://www.chargebee.com/docs/charges.html#non-recurring-addon )\ncan be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)\nis used by default. Provide the value as a decimal string in major units of the currency. This parameter can only be passed when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      },
                      "date_from" : {
                        "type" : "array",
                        "description" : "The time when the service period for the addon starts.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "unix-time",
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      },
                      "date_to" : {
                        "type" : "array",
                        "description" : "The time when the service period for the addon ends.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "unix-time",
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "charges" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for charges\n",
                    "properties" : {
                      "amount" : {
                        "type" : "array",
                        "description" : "The amount to be charged. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                        "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 ).\nProvide the value in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      },
                      "description" : {
                        "type" : "array",
                        "description" : "Description for this charge\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 250,
                          "example" : null
                        },
                        "example" : null
                      },
                      "taxable" : {
                        "type" : "array",
                        "description" : "The amount to be charged is taxable or not.\n",
                        "items" : {
                          "type" : "boolean",
                          "default" : true,
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax_profile_id" : {
                        "type" : "array",
                        "description" : "Tax profile of the charge.\n",
                        "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)\n.\n",
                        "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)\nto which the item is mapped for calculating the customer's tax in India. Applicable only when both of the following conditions are true:\n\n* [**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.)\n* The [**AvaTax for Sales** integration](https://www.chargebee.com/docs/avalara.html) has been enabled in Chargebee.\n",
                        "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)\n.\n",
                        "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)\nintegration.\n\n* vendor_use - Transaction is for an item that is subject to vendor use tax\n* retail - Transaction is a sale to an end user\n* consumed - Transaction is for an item that is consumed directly\n* wholesale - Transaction is a sale to another company that will resell your product or service to another consumer\n",
                          "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)\nintegration.\n",
                        "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)\nintegration.\n",
                        "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.\n",
                        "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.\n",
                        "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\n",
                    "properties" : {
                      "provider_name" : {
                        "type" : "array",
                        "description" : "Name of the tax provider currently supported.\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 us.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "field_value" : {
                        "type" : "array",
                        "description" : "The value of the corresponding tax field.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "notes_to_remove" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for notes_to_remove\n",
                    "properties" : {
                      "entity_type" : {
                        "type" : "array",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "description" : "Type of entity to which the [note](/docs/api/invoices/invoice-object#notes)\nbelongs. To remove the general note, use the `remove_general_note`\nparameter.\n\n* coupon - Entity that represents a coupon.\n* addon - Entity that represents an addon.\n* plan - Entity that represents a plan.\n* customer - Entity that represents a customer.\n* subscription - Entity that represents a subscription of customer.\n",
                          "enum" : [ "plan", "addon", "customer", "subscription", "coupon" ],
                          "example" : null
                        },
                        "example" : null
                      },
                      "entity_id" : {
                        "type" : "array",
                        "description" : "Unique identifier of the [note](/docs/api/invoices/invoice-object#notes)\n.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  }
                },
                "example" : null
              },
              "encoding" : {
                "addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "bank_account" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "card" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "charges" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "notes_to_remove" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "payment_intent" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "payment_method" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "shipping_address" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "statement_descriptor" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "tax_providers_fields" : {
                  "style" : "deepObject",
                  "explode" : true
                }
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "invoice" : {
                      "$ref" : "#/components/schemas/Invoice",
                      "description" : "Resource object representing invoice\n"
                    }
                  },
                  "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_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\nUse 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" : "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)\nto 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)\nor any document such as the [Invoice PDF](/docs/api/invoices/retrieve-invoice-as-pdf)\n.\n",
                    "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.\n",
                    "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\n"
                    },
                    "credit_note" : {
                      "$ref" : "#/components/schemas/CreditNote",
                      "description" : "Resource object representing credit_note\n"
                    }
                  },
                  "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" : "Finalizes a `pending` invoice. Invoices are created with a `pending` `status` when [Metered Billing](https://www.chargebee.com/docs/metered_billing.html) is enabled. Ensure that usage charges are added before invoking this API as an invoice without any `line_items` cannot be closed. 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.\n\n#### Related Tutorial\n\n* [Check out the tutorial on how to use metered / usage based billing.](https://www.chargebee.com/tutorials/usage-based-billing-example.html)\n",
        "operationId" : "close_a_pending_invoice",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "invoice-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/invoice-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "additionalProperties" : true,
                "properties" : {
                  "comment" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "An internal [comment](/docs/api/comments)\nto 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)\nor any document such as the [Invoice PDF](/docs/api/invoices/retrieve-invoice-as-pdf)\n.\n",
                    "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)\nfor the invoice are displayed on the PDF invoice sent to the customer.\n",
                    "maxLength" : 2000,
                    "example" : null
                  },
                  "remove_general_note" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "Set as `true`\nto remove the [**general note**](https://www.chargebee.com/docs/invoice_notes.html#adding-general-notes)\nfrom this invoice.\n",
                    "example" : null
                  },
                  "invoice_date" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "Set the [invoice date](/docs/api/invoices/invoice-object#date).\nMust 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)\nis used.\n",
                    "example" : null
                  },
                  "notes_to_remove" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for notes_to_remove\n",
                    "properties" : {
                      "entity_type" : {
                        "type" : "array",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "description" : "Type of entity to which the [note](/docs/api/invoices/invoice-object#notes)\nbelongs. To remove the general note, use the `remove_general_note`\nparameter.\n\n* customer - Entity that represents a customer.\n* plan - Entity that represents a plan.\n* coupon - Entity that represents a coupon.\n* addon - Entity that represents an addon.\n* subscription - Entity that represents a subscription of customer.\n",
                          "enum" : [ "plan", "addon", "customer", "subscription", "coupon" ],
                          "example" : null
                        },
                        "example" : null
                      },
                      "entity_id" : {
                        "type" : "array",
                        "description" : "Unique identifier of the [note](/docs/api/invoices/invoice-object#notes)\n.\n",
                        "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\n"
                    }
                  },
                  "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" : "This API applies [available credits](/docs/api/customers/customer-object#balances) to an invoice. After credits are applied, [invoice.amount_due](/docs/api/invoices/invoice-object#amount_due) is recalculated. The invoice status changes to either `paid` or `payment_due` depending on how much credit is applied to the invoice amount.\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" : "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)\nto 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)\nor any document such as the [Invoice PDF](/docs/api/invoices/retrieve-invoice-as-pdf)\n.\n",
                    "maxLength" : 300,
                    "example" : null
                  },
                  "credit_notes" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for credit_notes\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "The Credit Note number acts as an identifier for Credit Notes and is typically generated sequentially. Available refundable credits with the customer will be applied against this invoice if this paramenter is not passed.\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\n"
                    }
                  },
                  "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/v2/pcv-1/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" : "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/v2/pcv-1/email_logs) objects for the send request. Each entry describes one email that was sent or attempted.\n",
                      "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" : "**Important**\n\nFor sites where both [legacy and latest](/docs/api/v2/pcv-1/upgrade#retrieving-api-responses-in-latest-api-format) product catalog versions are active, GET API requests return responses in a `compat` format by default. This format works with both latest and legacy Product Catalog.\n\n**Override options:**\n\n* `chargebee-response-schema-type: items` → Return response in latest product catalog format only.\n* `chargebee-response-schema-type: plans_addons` → Return response in legacy product catalog format only.\n\nRetrieve the invoice for the specified invoice ID.\n",
        "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" : "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\n"
                    }
                  },
                  "required" : [ "invoice" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/invoices/charge" : {
      "post" : {
        "tags" : [ "invoices" ],
        "summary" : "Create invoice for a one-time charge",
        "description" : "Generate invoices for a one-time charge using this API.\n",
        "operationId" : "create_invoice_for_a_one-time_charge",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "customer_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Identifier of the customer for which this invoice needs to be created. Should be specified if 'subscription_id' is not specified.\n",
                    "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).\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "currency_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The currency code (ISO 4217 format) of the invoice amount. Applicable only while creating an invoice for a customer (by specifying *customer_id*\n).\n",
                    "maxLength" : 3,
                    "example" : null
                  },
                  "amount" : {
                    "type" : "integer",
                    "format" : "int64",
                    "deprecated" : false,
                    "description" : "The amount to be charged. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                    "minimum" : 1,
                    "example" : null
                  },
                  "amount_in_decimal" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The decimal representation of the amount for the [one-time charge](https://www.chargebee.com/docs/charges.html#one-time-charges ).\nProvide the value in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                    "maxLength" : 39,
                    "example" : null
                  },
                  "description" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Description for this charge.\n",
                    "maxLength" : 250,
                    "example" : null
                  },
                  "date_from" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "The time when the service period for the charge starts.\n",
                    "example" : null
                  },
                  "date_to" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "The time when the service period for the charge ends.\n",
                    "example" : null
                  },
                  "coupon_ids" : {
                    "type" : "array",
                    "deprecated" : false,
                    "description" : "List of Coupons to be added.\n",
                    "items" : {
                      "type" : "string",
                      "deprecated" : false,
                      "maxLength" : 100,
                      "example" : null
                    },
                    "example" : null
                  },
                  "avalara_sale_type" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Indicates the type of sale carried out. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)\nintegration.\n\n* retail - Transaction is a sale to an end user\n* vendor_use - Transaction is for an item that is subject to vendor use tax\n* wholesale - Transaction is a sale to another company that will resell your product or service to another consumer\n* consumed - Transaction is for an item that is consumed directly\n",
                    "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)\nintegration.\n",
                    "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)\nintegration.\n",
                    "example" : null
                  },
                  "po_number" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Purchase Order Number for this invoice.\n",
                    "maxLength" : 100,
                    "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.\n`taxes`\nand\n`line_item_taxes`\nare 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.\n",
                    "example" : null
                  },
                  "payment_source_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Payment source to be used for this payment.\n",
                    "maxLength" : 40,
                    "example" : null
                  },
                  "payment_initiator" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The type of initiator to be used for the payment request triggered by this operation.\n\n* customer - Pass this value to indicate that the request is initiated by the customer\n* merchant - Pass this value to indicate that the request is initiated by the merchant\n",
                    "enum" : [ "customer", "merchant" ],
                    "example" : null
                  },
                  "tax_providers_fields" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for tax_providers_fields\n",
                    "properties" : {
                      "provider_name" : {
                        "type" : "array",
                        "description" : "Name of the tax provider currently supported.\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 us.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "field_value" : {
                        "type" : "array",
                        "description" : "The value of the corresponding tax field.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  }
                },
                "required" : [ "description" ],
                "example" : null
              },
              "encoding" : {
                "tax_providers_fields" : {
                  "style" : "deepObject",
                  "explode" : true
                }
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "invoice" : {
                      "$ref" : "#/components/schemas/Invoice",
                      "description" : "Resource object representing invoice\n"
                    }
                  },
                  "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" : "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)\n.\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).\nOnly applicable specifically for customers with [billing_address](/docs/api/customers/customer-object#billing_address)\n\n`country`\nas `XI`\n(which is **United Kingdom - Northern Ireland**\n).\n\nWhen you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\nin 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\nthe Brexit configuration, you have the option of setting [billing_address](/docs/api/customers/customer-object#billing_address)\n\n`country`\nas `XI`.\nThat's the code for **United Kingdom - Northern Ireland** .\nThe first two characters of the VAT number in such a case is\n`XI`\nby default. However, if the VAT number was registered in UK, the value should be `GB`.\nSet\n`vat_number_prefix`\nto `GB`\nfor such cases.\n",
                    "maxLength" : 10,
                    "example" : null
                  },
                  "po_number" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Purchase Order Number for this invoice.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "comment" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "An internal [comment](/docs/api/comments)\nto 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)\nor any document such as the [Invoice PDF](/docs/api/invoices/retrieve-invoice-as-pdf)\n.\n",
                    "maxLength" : 300,
                    "example" : null
                  },
                  "billing_address" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for billing_address\n",
                    "properties" : {
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The first name of the billing contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The last name of the billing contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "The email address.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "company" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The company name.\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The phone number.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line3" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 3\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "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`\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.\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://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.\n\n* invalid - Address is invalid.\n* valid - Address was validated successfully.\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* not_validated - Address is not yet validated.\n",
                        "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "shipping_address" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for shipping_address\n",
                    "properties" : {
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The first name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The last name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "The email address.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "company" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The company name.\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The phone number.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line3" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 3\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "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`\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.\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://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.\n\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n* valid - Address was validated successfully.\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n",
                        "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" : "Describes the transaction to help your customer easily recognize it.\n",
                        "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\n"
                    }
                  },
                  "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" : "To record a [offline payment](https://www.chargebee.com/docs/payments/2.0/offline-checkout/offline_payments) for an invoice.\n\nThe invoice status will be marked as 'paid' if its amount due becomes 0 because of this recorded payment.\n\n**Note:** If the payment transaction amount is more than the invoice due amount, the remaining transaction amount will be added to the customer's Excess Payments balance to be used against other invoices.\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" : "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.\n",
                    "maxLength" : 300,
                    "example" : null
                  },
                  "transaction" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for transaction\n",
                    "properties" : {
                      "amount" : {
                        "type" : "integer",
                        "format" : "int64",
                        "deprecated" : false,
                        "description" : "The payment transaction amount. If not specified, this value will be the invoice's due amount.\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 - Custom\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.\n",
                        "maxLength" : 100,
                        "example" : null
                      },
                      "custom_payment_method_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Identifier of the custom payment method of this transaction.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "id_at_gateway" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The id with which this transaction is referred in gateway.\n",
                        "maxLength" : 100,
                        "example" : null
                      },
                      "status" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The status of this transaction.\n\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* success - The transaction is successful.\n",
                        "enum" : [ "success", "failure", "late_failure" ],
                        "example" : null
                      },
                      "date" : {
                        "type" : "integer",
                        "format" : "unix-time",
                        "deprecated" : false,
                        "description" : "Indicates when this transaction occurred.\n",
                        "example" : null
                      },
                      "error_code" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Error code received from the payment gateway on failure.\n",
                        "maxLength" : 100,
                        "example" : null
                      },
                      "error_text" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Error message received from the payment gateway on 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\n"
                    },
                    "transaction" : {
                      "$ref" : "#/components/schemas/Transaction",
                      "description" : "Resource object representing transaction\n"
                    }
                  },
                  "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. Any payments must be [removed](/docs/api/invoices/remove-payment-from-an-invoice) from the invoice before deleting it.\n\n* Any [promotional credits](/docs/api/promotional_credits) or [credit notes](/docs/api/credit_notes) applied to the invoice are removed.\n* If an invoice for the current term of a subscription is deleted and the subscription is changed later with `proration` enabled, no prorated credits are issued.\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" : "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.\n",
                    "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.\n",
                    "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\n"
                    }
                  },
                  "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. This endpoint allows you to import an invoice from external systems, such as accounting software, into Chargebee.  \n**Caution: Importing Current-Term Invoices**\nTo ensure accurate [proration](https://www.chargebee.com/docs/1.0/proration.html#introduction_proration) for any changes to the subscription in the current term, only import one current term invoice. Chargebee considers only the first imported invoice for the current term when calculating proration. If there are multiple invoices for the current term in the source system, consolidate them into a single invoice before importing it into Chargebee.\n",
        "operationId" : "import_invoice",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "additionalProperties" : true,
                "properties" : {
                  "id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Invoice Number.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "currency_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The currency code (ISO 4217 format) for the invoice.\n",
                    "maxLength" : 3,
                    "example" : null
                  },
                  "customer_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Identifier of the customer for which this invoice needs to be created.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "subscription_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "If recurring items are present in line items then subscription id is required.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "po_number" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Purchase Order Number for this invoice.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "price_type" : {
                    "type" : "string",
                    "default" : "tax_exclusive",
                    "deprecated" : false,
                    "description" : "The price type of the invoice.\n\n* tax_inclusive - All amounts in the document are inclusive of tax.\n* tax_exclusive - All amounts in the document are exclusive of tax.\n",
                    "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.).\n\n* zero_rated - If the rate of tax is 0% and no Sales/ GST tax is collectable for that line item\n* export - The customer is from a non-taxable region or the billing address and shipping address are unavailable.\n* customer_exempt -\n  The customer is [exempted](/docs/api/customers/customer-object#taxability)\n  from tax.\n* tax_not_configured_external_provider - If the tax is not configured for the country in 3rd party tax provider.\n* id_exempt -\n  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)\n  or [UK VAT](https://www.chargebee.com/docs/uk-vat.html)\n  is enabled.)\n* 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\n* product_exempt - If the Plan or Addon is marked as Tax exempt\n* 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\n* 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.\n",
                    "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.\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).\nOnly applicable specifically for customers with [billing_address](/docs/api/customers/customer-object#billing_address)\n\n`country`\nas `XI`\n(which is **United Kingdom - Northern Ireland**\n).\n\nWhen you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\nin 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\nthe Brexit configuration, you have the option of setting [billing_address](/docs/api/customers/customer-object#billing_address)\n\n`country`\nas `XI`.\nThat's the code for **United Kingdom - Northern Ireland** .\nThe first two characters of the VAT number in such a case is\n`XI`\nby default. However, if the VAT number was registered in UK, the value should be `GB`.\nSet\n`vat_number_prefix`\nto `GB`\nfor such cases.\n",
                    "maxLength" : 10,
                    "example" : null
                  },
                  "date" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "Date when invoice raised.\n",
                    "example" : null
                  },
                  "total" : {
                    "type" : "integer",
                    "format" : "int64",
                    "deprecated" : false,
                    "description" : "Invoice total amount.\n",
                    "minimum" : 0,
                    "example" : null
                  },
                  "round_off" : {
                    "type" : "integer",
                    "format" : "int64",
                    "deprecated" : false,
                    "description" : "Round off amount.\n",
                    "maximum" : 99,
                    "minimum" : -99,
                    "example" : null
                  },
                  "status" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Current status of this invoice.\n\n* not_paid - Indicates the payment is not made and all attempts to collect is failed.\n* voided - Indicates a voided invoice.\n* 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* pending -\n  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`.\n  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.\n* payment_due - Indicates the payment is not yet collected and is being retried as per retry settings.\n",
                    "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.\n",
                    "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**.\nMust be passed if set as mandatory in the app. The codes are case-sensitive.\n",
                    "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.\n",
                    "example" : null
                  },
                  "write_off_amount" : {
                    "type" : "integer",
                    "format" : "int64",
                    "default" : 0,
                    "deprecated" : false,
                    "description" : "Amount written off against this invoice.\nIf this value is not present then the due amount of the invoice will be written off.\n",
                    "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.\nThis is a mandatory field if is_written_off is true. The same date reflects on the created credit note.\n",
                    "example" : null
                  },
                  "due_date" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "Invoice Due Date.\n",
                    "example" : null
                  },
                  "net_term_days" : {
                    "type" : "integer",
                    "format" : "int32",
                    "default" : 0,
                    "deprecated" : false,
                    "description" : "Invoice net term days.\n",
                    "example" : null
                  },
                  "has_advance_charges" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "Boolean indicating any advance charge is present in this invoice.\n",
                    "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.\n",
                    "example" : null
                  },
                  "paid_at" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "Timestamp when the invoice was paid. Applicable only when `status` is `paid`.\n",
                    "example" : null
                  },
                  "credit_note" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for credit_note\n",
                    "properties" : {
                      "id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "A unique identifier for the credit note.\n\nThis is a mandatory field if is_written_off is true.\n",
                        "maxLength" : 50,
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "billing_address" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for billing_address\n",
                    "properties" : {
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The first name of the billing contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The last name of the billing contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "The email address.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "company" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The company name.\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The phone number.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line3" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 3\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "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`\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.\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://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.\n\n* valid - Address was validated successfully.\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n",
                        "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "shipping_address" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for shipping_address\n",
                    "properties" : {
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The first name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The last name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "The email address.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "company" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The company name.\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The phone number.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line3" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 3\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "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`\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.\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://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.\n\n* not_validated - Address is not yet validated.\n* valid - Address was validated successfully.\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n",
                        "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "line_items" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for line_items\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "Uniquely identifies a line_item\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 40,
                          "example" : null
                        },
                        "example" : null
                      },
                      "date_from" : {
                        "type" : "array",
                        "description" : "Start date of this line item.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "unix-time",
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      },
                      "date_to" : {
                        "type" : "array",
                        "description" : "End date of this line item.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "unix-time",
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      },
                      "subscription_id" : {
                        "type" : "array",
                        "description" : "A unique identifier for the subscription this line item belongs to.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "description" : {
                        "type" : "array",
                        "description" : "Description for this line item\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 250,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_amount" : {
                        "type" : "array",
                        "description" : "Unit amount of the line item.\n",
                        "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).\n[Quantity of the recurring item](/docs/api/v2/pcv-1/invoices/invoice-object#line_items_quantity) which is represented by this line item.\n",
                        "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\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`.\nThe value is in major units of the currency. Returned when the `line_item`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "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`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "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`\n, in major units of the currency. Typically equals to `unit_amount_in_decimal`\nx `quantity_in_decimal`.\nReturned when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "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.\n\n* addon -\n  Indicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the [addon](/docs/api/v2/pcv-1/addons/addon-object)\n  id\n* plan -\n  Indicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)\n  id\n* adhoc - Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case\n* plan_setup -\n  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)\n  id\n",
                          "enum" : [ "plan_setup", "plan", "addon", "adhoc" ],
                          "example" : null
                        },
                        "example" : null
                      },
                      "entity_id" : {
                        "type" : "array",
                        "description" : "The identifier of the modelled entity this line item is based on. Will be null for 'adhoc' entity type\n",
                        "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\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "item_level_discount1_amount" : {
                        "type" : "array",
                        "description" : "First item level discount amount\n",
                        "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\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "item_level_discount2_amount" : {
                        "type" : "array",
                        "description" : "Second item level discount amount\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax1_name" : {
                        "type" : "array",
                        "description" : "First tax name\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax1_amount" : {
                        "type" : "array",
                        "description" : "First tax amount\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax2_name" : {
                        "type" : "array",
                        "description" : "Second tax name\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax2_amount" : {
                        "type" : "array",
                        "description" : "Second tax amount\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax3_name" : {
                        "type" : "array",
                        "description" : "Third tax name\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax3_amount" : {
                        "type" : "array",
                        "description" : "Third tax amount\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax4_name" : {
                        "type" : "array",
                        "description" : "Fourth tax name\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax4_amount" : {
                        "type" : "array",
                        "description" : "Fourth tax amount\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax5_name" : {
                        "type" : "array",
                        "description" : "Fifth tax name\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax5_amount" : {
                        "type" : "array",
                        "description" : "Fifth tax amount\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax6_name" : {
                        "type" : "array",
                        "description" : "Sixth tax name\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax6_amount" : {
                        "type" : "array",
                        "description" : "Sixth tax amount\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax7_name" : {
                        "type" : "array",
                        "description" : "Seventh tax name\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax7_amount" : {
                        "type" : "array",
                        "description" : "Seventh tax amount\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax8_name" : {
                        "type" : "array",
                        "description" : "Eighth tax name\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax8_amount" : {
                        "type" : "array",
                        "description" : "Eighth tax amount\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax9_name" : {
                        "type" : "array",
                        "description" : "Ninth tax name\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax9_amount" : {
                        "type" : "array",
                        "description" : "Ninth tax amount\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax10_name" : {
                        "type" : "array",
                        "description" : "Tenth tax name\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax10_amount" : {
                        "type" : "array",
                        "description" : "Tenth tax amount\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 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.\n",
                          "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\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "If `id`\nis not provided then our system will automatically generate a unique id.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 40,
                          "example" : null
                        },
                        "example" : null
                      },
                      "type" : {
                        "type" : "array",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "description" : "This attribute helps `type`\nfield in the API, specifies how to reconcile offline payments, and generate `payment_reference_number`\non invoices based on country-specific rules. Setting the `type`\nfield generates `payment_reference_number`\nfor the respective country and includes them on the invoice for correct reconciliation.\n\n* swiss_reference - Switzerland based number calculated using MOD 10 and Mod 95 algorithm based on reference type.\n* kid - The KID number (kundeidentifikasjon) in Norway is an abbreviation for \"Customer identification\". It is used to associate payments with the customer and invoice.\n* fik - Denmark based number calculated using recursive MOD 10 algorithm.\n* 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.\n* 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.\n",
                          "enum" : [ "kid", "ocr", "frn", "fik", "swiss_reference" ],
                          "example" : null
                        },
                        "example" : null
                      },
                      "number" : {
                        "type" : "array",
                        "description" : "If you have already generated a `payment_reference_number`\nin 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`\nAPI.\n",
                        "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\n",
                    "properties" : {
                      "line_item_id" : {
                        "type" : "array",
                        "description" : "Uniquely identifies a line_item\n",
                        "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\n",
                        "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\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_used" : {
                        "type" : "array",
                        "description" : "The number of units purchased in a range.\n",
                        "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`\npricing , or the price of each unit in the tier if the charge model is `tiered`\n/`volume`\npricing.\n",
                        "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`\nof the next lower tier. Returned only when the `line_items.pricing_model`\nis `tiered`\n, `volume`\nor `stairstep`\nand [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis 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. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the `starting_unit_in_decimal`\nof the next higher tier. Returned only when the `line_items.pricing_model`\nis `tiered`\n, `volume`\nor stairstep and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "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`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "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`\nis `tiered`\nor `volume`.\nWhen the `pricing_model`\nis `stairstep`\n, it is the decimal representation of the total price for `line_item`.\nThe value is in major units of the currency. Returned when the `line_item`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "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\n",
                    "properties" : {
                      "line_item_id" : {
                        "type" : "array",
                        "description" : "The unique id of the line item that this deduction is for. Is required when `discounts[entity_type]`\nis `item_level_coupon`\nor `document_level_coupon`\n.\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.\n\n* item_level_coupon -\n  The deduction is due to a coupon applied to line item. The coupon `id`\n  is passed as `entity_id`\n  .\n* document_level_coupon -\n  The deduction is due to a coupon applied to the invoice `sub_total`.\n  The coupon id is passed as `entity_id`\n  .\n* promotional_credits -\n  The deduction is due to a [promotional credit](/docs/api/promotional_credits)\n  applied to the invoice.\n",
                          "enum" : [ "item_level_coupon", "document_level_coupon", "promotional_credits" ],
                          "example" : null
                        },
                        "example" : null
                      },
                      "entity_id" : {
                        "type" : "array",
                        "description" : "When the deduction is due to a `coupon`\n, then this is the `id`\nof the coupon. Is required when `discounts[entity_type]`\nis `item_level_coupon`\nor `document_level_coupon`\n.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "description" : {
                        "type" : "array",
                        "description" : "Description for this deduction.\n",
                        "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)\n.\n",
                        "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\n",
                    "properties" : {
                      "name" : {
                        "type" : "array",
                        "description" : "The name of the tax applied\n",
                        "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",
                        "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\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "description" : {
                        "type" : "array",
                        "description" : "Description of tax\n",
                        "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\n\n* country - The tax jurisdiction is a country\n* special - Special tax jurisdiction.\n* state - The tax jurisdiction is a state\n* city - The tax jurisdiction is a city\n* other - Jurisdictions other than the ones listed above.\n* unincorporated - Combined tax of state and county.\n* federal - The tax jurisdiction is a federal\n* county - The tax jurisdiction is a county\n",
                          "enum" : [ "country", "federal", "state", "county", "city", "special", "unincorporated", "other" ],
                          "example" : null
                        },
                        "example" : null
                      },
                      "juris_name" : {
                        "type" : "array",
                        "description" : "The name of the tax jurisdiction\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 250,
                          "example" : null
                        },
                        "example" : null
                      },
                      "juris_code" : {
                        "type" : "array",
                        "description" : "The tax jurisdiction code\n",
                        "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\n",
                    "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\n",
                        "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\n\n* check - Check\n* bank_transfer - Bank Transfer\n* custom - Custom\n* other - Payment Methods other than the above types\n* cash - Cash\n",
                          "enum" : [ "cash", "check", "bank_transfer", "other", "custom", "tamara", "qpay", "blik", "fpx", "wero", "p24" ],
                          "example" : null
                        },
                        "example" : null
                      },
                      "date" : {
                        "type" : "array",
                        "description" : "Payment date\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "unix-time",
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      },
                      "reference_number" : {
                        "type" : "array",
                        "description" : "Reference number for this payment\n",
                        "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\n",
                    "properties" : {
                      "entity_type" : {
                        "type" : "array",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "description" : "Type of entity to which the note belongs.\n\n* plan_item_price - Indicates that this line item is based on plan Item Price\n* plan - Entity that represents a plan.\n* coupon - Entity that represents a coupon.\n* addon_item_price - Indicates that this line item is based on addon Item Price\n* charge_item_price - Indicates that this line item is based on charge Item Price\n* addon - Entity that represents an addon.\n",
                          "enum" : [ "plan", "addon", "coupon", "plan_item_price", "addon_item_price", "charge_item_price" ],
                          "example" : null
                        },
                        "example" : null
                      },
                      "entity_id" : {
                        "type" : "array",
                        "description" : "Id of the mentioned entity type\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "note" : {
                        "type" : "array",
                        "description" : "Actual note.\n",
                        "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.\n",
                    "properties" : {
                      "line_item_id" : {
                        "type" : "array",
                        "description" : "Line item reference\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 40,
                          "example" : null
                        },
                        "example" : null
                      },
                      "first_name" : {
                        "type" : "array",
                        "description" : "First name of the customer\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 150,
                          "example" : null
                        },
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "array",
                        "description" : "Last name of the customer\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 150,
                          "example" : null
                        },
                        "example" : null
                      },
                      "email" : {
                        "type" : "array",
                        "description" : "Email address of the customer\n",
                        "items" : {
                          "type" : "string",
                          "format" : "email",
                          "deprecated" : false,
                          "maxLength" : 70,
                          "example" : null
                        },
                        "example" : null
                      },
                      "company" : {
                        "type" : "array",
                        "description" : "Name of the company\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 250,
                          "example" : null
                        },
                        "example" : null
                      },
                      "phone" : {
                        "type" : "array",
                        "description" : "Phone number of the customer\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "line1" : {
                        "type" : "array",
                        "description" : "Address line 1\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 150,
                          "example" : null
                        },
                        "example" : null
                      },
                      "line2" : {
                        "type" : "array",
                        "description" : "Address line 2\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 150,
                          "example" : null
                        },
                        "example" : null
                      },
                      "line3" : {
                        "type" : "array",
                        "description" : "Address line 3\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 150,
                          "example" : null
                        },
                        "example" : null
                      },
                      "city" : {
                        "type" : "array",
                        "description" : "Name of the city\n",
                        "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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "state" : {
                        "type" : "array",
                        "description" : "State or Province\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://i18napis.appspot.com/address)\n.\n",
                        "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).\nEntering 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.\n\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* valid - Address was validated successfully.\n",
                          "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\n"
                    },
                    "credit_note" : {
                      "$ref" : "#/components/schemas/CreditNote",
                      "description" : "Resource object representing credit_note\n"
                    }
                  },
                  "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/1.0/dunning-v2.html) for the specified invoice.\n\n* If the current time is within the dunning period for the invoice, Chargebee resumes any dunning [retries](https://www.chargebee.com/docs/payments/1.0/dunning-v2.html) and [email notifications](https://www.chargebee.com/docs/payments/1.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.\n* If the current time is after the dunning period for the invoice, the [final action](https://www.chargebee.com/docs/payments/1.0/dunning-v2.html) configured in Billing is initiated for the invoice and, if applicable, for the subscription.\n\n#### Prerequisites\n\nThis operation is only permitted for an invoice with a [status](/docs/api/v2/pcv-1/invoices/invoice-object#status) of `payment_due` and for which dunning was previously [paused](/docs/api/v2/pcv-1/invoices/pause-dunning-for-invoice).\n",
        "operationId" : "resume_dunning_for_invoice",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "invoice-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/invoice-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "comment" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Reason for deleting this transaction. This comment will be added to the associated entity.\n",
                    "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\n"
                    }
                  },
                  "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:\n\n* Tax Amount Withheld is enabled.\n* The `invoice` does not have a `linked_taxes_withheld` record associated with it already.\n* `invoice.amount_due` is greater than zero.\n* `invoice.status` is one of the following: `payment_due`, `not_paid`, or `posted`.\n",
        "operationId" : "record_tax_withheld_for_an_invoice",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "invoice-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/invoice-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "tax_withheld" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for tax_withheld\n",
                    "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).\nThe unit depends on the [type of currency](/docs/api/getting-started).\n",
                        "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.\n",
                        "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.\n",
                        "example" : null
                      },
                      "description" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The description for this tax withheld.\n",
                        "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\n"
                    }
                  },
                  "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.\n",
        "operationId" : "resend_failed_einvoice_in_invoices",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "invoice-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/invoice-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : { },
                "example" : null
              },
              "encoding" : { }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "invoice" : {
                      "$ref" : "#/components/schemas/Invoice",
                      "description" : "Resource object representing invoice\n"
                    }
                  },
                  "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:\n\n* [invoice.status](/docs/api/invoices/invoice-object#status) is one of the following: `payment_due`, `not_paid`, or `posted`.\n* There are no [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes) associated with the invoice.\n* There are no [issued_credit_notes](/docs/api/invoices/invoice-object#issued_credit_notes) associated with the invoice.\n",
        "operationId" : "remove_tax_withheld_for_an_invoice",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "invoice-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/invoice-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "tax_withheld" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for tax_withheld\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_`.\nFor example, `tax_wh_16BdDXSlbu4uV1Ee6`\n.\n",
                        "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\n"
                    }
                  },
                  "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`\nor the `payment_reference_number[number]`\nto retrieve the PRN.\n",
        "operationId" : "list_payment_reference_numbers",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "limit",
          "in" : "query",
          "description" : "The number of resources to be returned.\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`\nto the value of `next_offset`\nobtained in the previous iteration of the API call.\n",
          "required" : false,
          "deprecated" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "maxLength" : 1000,
            "example" : null
          }
        }, {
          "name" : "id",
          "in" : "query",
          "description" : "optional, string filter\n\nAn unique identifier for the invoice serves that links the invoice to the corresponding payment reference number (PRN).\n**Note** :\nTo 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.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*id\\[is\\] = \"old_inv_001\"*\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "example" : "old_inv_001",
            "properties" : {
              "is" : {
                "type" : "string",
                "minLength" : 1,
                "example" : null
              },
              "in" : {
                "type" : "string",
                "pattern" : "^\\[(.*)(,.*)*\\]$",
                "example" : null
              }
            }
          }
        }, {
          "name" : "payment_reference_number",
          "in" : "query",
          "description" : "Parameters for payment_reference_number\n",
          "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.\n**Note**:\nTo 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.\n",
                "example" : "001234",
                "properties" : {
                  "is" : {
                    "type" : "string",
                    "minLength" : 1,
                    "example" : null
                  },
                  "in" : {
                    "type" : "string",
                    "pattern" : "^\\[(.*)(,.*)*\\]$",
                    "example" : null
                  }
                }
              }
            },
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "list" : {
                      "type" : "array",
                      "items" : {
                        "type" : "object",
                        "properties" : {
                          "payment_reference_number" : {
                            "$ref" : "#/components/schemas/PaymentReferenceNumber",
                            "description" : "Resource object representing payment_reference_number"
                          }
                        },
                        "required" : [ "payment_reference_number" ],
                        "example" : null
                      },
                      "example" : null
                    },
                    "next_offset" : {
                      "type" : "string",
                      "description" : "This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.\n",
                      "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" : "**Important:**\n\n* 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.\n* This endpoint returns an error if a payment is initiated for an invoice with a [status](/docs/api/invoices/invoice-object#status) of `payment_due` associated with the `app_store` and `play_store` [channels](/docs/api/invoices/invoice-object#channel).\n\nThis API is used to collect payments for `payment_due` and `not_paid invoices`. If no payment methods are present for the customer or if the payment is unsuccessful, the corresponding error will be thrown.\nPass `authorization_transaction_id` to capture the already blocked funds to collect payments. Note that if the invoice due amount is greater than the authorized amount, the invoice status is returned as `payment_due`.  \nThe authorization transaction will not be captured if the fraud status is found as suspicious. This api will result in invalid_state_for_request error. Read more on [fraud management using Stripe Radar](https://www.chargebee.com/docs/stripe-radar.html)\n.\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" : "invoice-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/invoice-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "amount" : {
                    "type" : "integer",
                    "format" : "int64",
                    "deprecated" : false,
                    "description" : "Amount to be collected. If this parameter is not passed then the entire amount due will be collected.\n",
                    "minimum" : 1,
                    "example" : null
                  },
                  "authorization_transaction_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Authorization transaction to be captured.\n",
                    "maxLength" : 40,
                    "example" : null
                  },
                  "payment_source_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Payment source to be used for this payment.\n",
                    "maxLength" : 40,
                    "example" : null
                  },
                  "comment" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "An internal [comment](/docs/api/comments)\nto 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)\nor any document such as the [Invoice PDF](/docs/api/invoices/retrieve-invoice-as-pdf)\n.\n",
                    "maxLength" : 300,
                    "example" : null
                  },
                  "payment_initiator" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The type of initiator to be used for the payment request triggered by this operation.\n\n* merchant - Pass this value to indicate that the request is initiated by the merchant\n* customer - Pass this value to indicate that the request is initiated by the customer\n",
                    "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\n"
                    },
                    "transaction" : {
                      "$ref" : "#/components/schemas/Transaction",
                      "description" : "Resource object representing transaction\n"
                    }
                  },
                  "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.\n**Note:** This operation is done automatically while [closing](/docs/api/invoices/close-a-pending-invoice) the invoice.\n",
        "operationId" : "sync_usages",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "invoice-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/invoice-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "invoice" : {
                      "$ref" : "#/components/schemas/Invoice",
                      "description" : "Resource object representing invoice\n"
                    }
                  },
                  "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 the invoice. The [refund](https://www.chargebee.com/docs/refunds.html) request is processed via the payment gateway originally used to charge the customer. You can choose to either make a full refund for the entire amount or make many partial refunds until you reach the total amount charged for the invoice. The API returns an error if an attempt is made to:\n\n* Refund an offline invoice. For such invoices, use the [Record refund API](/docs/api/v2/pcv-1/invoices/record-refund-for-an-invoice).\n* Refund a fully refunded invoice.\n\nIf the refund transaction succeeds, a `credit_note` capturing this refund detail is created for the 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" : "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. If not specified, the entire refundable amount for this invoice is refunded. The refundable amount is the total amount paid via online `transaction`\ns, and not already refunded.\n\n**Note:**\nAny [linked_taxes_withheld](/docs/api/invoices/invoice-object#linked_taxes_withheld)\nassociated with the invoice cannot be refunded via this operation.\n",
                    "minimum" : 1,
                    "example" : null
                  },
                  "comment" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Comment, if any, on the refund.\n",
                    "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.\n",
                    "maxLength" : 2000,
                    "example" : null
                  },
                  "credit_note" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for credit_note\n",
                    "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)\nparameter instead\\]\n\n* product_unsatisfactory - Product Unsatisfactory\n* other - Can be set when none of the above reason codes are applicable\n* waiver - Waiver\n* order_cancellation - Order Cancellation\n* order_change - Order Change\n* service_unsatisfactory - Service Unsatisfactory\n",
                        "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\n",
                        "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\n"
                    },
                    "transaction" : {
                      "$ref" : "#/components/schemas/Transaction",
                      "description" : "Resource object representing transaction\n"
                    },
                    "credit_note" : {
                      "$ref" : "#/components/schemas/CreditNote",
                      "description" : "Resource object representing credit_note\n"
                    }
                  },
                  "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" : "Refunds the invoice. The refund is provided against the following in order of precedence:\n\n* Offline [linked_payments](/docs/api/invoices/invoice-object#linked_payments)\n* Any [linked_taxes_withheld](/docs/api/invoices/invoice-object#linked_taxes_withheld)\n* Online [linked_payments](/docs/api/invoices/invoice-object#linked_payments)\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 recording a refund worth $40, the refund amount is split as follows:\n\n* Refund against offline payments: $30\n* Refund against tax withheld: $5\n* Refund against online payments: $5\n\nFor payments made via online transactions, the [refund](https://www.chargebee.com/docs/refunds.html) request is processed via the payment gateway originally used to charge the customer.  \n**Tip**\n\nIf the order of precendence described above does not work for your use case, and you want to provide a refund against online `linked_payments` first, use the [Refund an invoice API](/docs/api/invoices/refund-an-invoice).\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" : "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.\n",
                    "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.\n",
                    "maxLength" : 2000,
                    "example" : null
                  },
                  "transaction" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for transaction\n",
                    "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.\n\n**Note:**\nAny [linked_taxes_withheld](/docs/api/invoices/invoice-object#linked_taxes_withheld)\nassociated with the invoice can also be recorded as refunded via this operation.\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 - Custom\n* check - Check\n* bank_transfer - Bank Transfer\n* chargeback -\n  Only applicable for a transaction of [type](/docs/api/transactions/transaction-object#type)\n  = `refund`.\n  This value is set by Chargebee when an automated [chargeback](https://www.chargebee.com/docs/chargeback.html#chargeback-process)\n  occurs. You can also set this explicitly when [recording a refund](/docs/api/transactions/record-an-offline-refund)\n  .\n",
                        "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)\n= `check`\n.\n",
                        "maxLength" : 100,
                        "example" : null
                      },
                      "custom_payment_method_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Identifier of the custom payment method of this transaction.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "date" : {
                        "type" : "integer",
                        "format" : "unix-time",
                        "deprecated" : false,
                        "description" : "Indicates when this transaction occurred.\n",
                        "example" : null
                      }
                    },
                    "required" : [ "date", "payment_method" ],
                    "example" : null
                  },
                  "credit_note" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for credit_note\n",
                    "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)\nparameter instead\\]\n\n* product_unsatisfactory - Product Unsatisfactory\n* chargeback - Can be set when you are recording your customer Chargebacks\n* service_unsatisfactory - Service Unsatisfactory\n* other - Can be set when none of the above reason codes are applicable\n* waiver - Waiver\n* order_cancellation - Order Cancellation\n* order_change - Order Change\n",
                        "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\n",
                        "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\n"
                    },
                    "transaction" : {
                      "$ref" : "#/components/schemas/Transaction",
                      "description" : "Resource object representing transaction\n"
                    },
                    "credit_note" : {
                      "$ref" : "#/components/schemas/CreditNote",
                      "description" : "Resource object representing credit_note\n"
                    }
                  },
                  "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.\n\n#### Related Tutorial\n\n* [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)\n",
        "operationId" : "retrieve_invoice_as_pdf",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "invoice-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/invoice-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "disposition_type" : {
                    "type" : "string",
                    "default" : "attachment",
                    "deprecated" : false,
                    "description" : "Determines the pdf should be rendered as inline or attachment in the browser.\n\n* attachment - PDF is rendered as attachment in the browser\n* inline - PDF is rendered as inline in the browser\n",
                    "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\n"
                    }
                  },
                  "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" : "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\n",
                      "items" : {
                        "$ref" : "#/components/schemas/Download",
                        "description" : "Resource object representing download"
                      },
                      "example" : null
                    }
                  },
                  "required" : [ "downloads" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/credit_notes/{credit-note-id}/record_refund" : {
      "post" : {
        "tags" : [ "credit_notes" ],
        "summary" : "Record refund for a credit note",
        "description" : "Refunds a ([refundable](https://www.chargebee.com/docs/credit-notes.html#types-of-credit-notes_refundable-credit-note)) credit note. The refund is provided against `linked_payments` first and then against any `linked_taxes_withheld` for the [invoice](/docs/api/credit_notes/credit_note-object#reference_invoice_id) associated with the `credit_note`. For payments made via online transactions, the refund request is processed via the [payment source](/docs/api/payment_sources) associated with the [transaction](/docs/api/transactions).\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" : "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**.\nMust be passed if set as mandatory in the app. The codes are case-sensitive.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "comment" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Remarks, if any, on the refund.\n",
                    "maxLength" : 300,
                    "example" : null
                  },
                  "transaction" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for transaction\n",
                    "properties" : {
                      "id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The payment transaction ID\n",
                        "maxLength" : 40,
                        "example" : null
                      },
                      "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](/docs/api/credit_notes/credit_note-object#amount_available)\nfor this `credit_note`\nis refunded.\n\nNote: Any [linked_tax_withheld_refunds](/docs/api/credit_notes/credit_note-object#linked_tax_withheld_refunds)\nassociated with the `credit_note`\ncan also be recorded as refunded via this operation.\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 - Custom\n* check - Check\n* bank_transfer - Bank Transfer\n* chargeback -\n  Only applicable for a transaction of [type](/docs/api/transactions/transaction-object#type)\n  = `refund`.\n  This value is set by Chargebee when an automated [chargeback](https://www.chargebee.com/docs/chargeback.html#chargeback-process)\n  occurs. You can also set this explicitly when [recording a refund](/docs/api/transactions/record-an-offline-refund)\n  .\n",
                        "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)\n= `check`\n.\n",
                        "maxLength" : 100,
                        "example" : null
                      },
                      "custom_payment_method_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Identifier of the custom payment method of this transaction.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "date" : {
                        "type" : "integer",
                        "format" : "unix-time",
                        "deprecated" : false,
                        "description" : "Indicates when this transaction occurred.\n",
                        "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\n"
                    },
                    "transaction" : {
                      "$ref" : "#/components/schemas/Transaction",
                      "description" : "Resource object representing transaction\n"
                    }
                  },
                  "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" : "Use this api to import credit notes into your Chargebee site. Billing address, Shipping Address, Vat number will be copied from the reference invoice.\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
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "additionalProperties" : true,
                "properties" : {
                  "id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Credit Note Number.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "customer_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "This identifies the customer for whom the credit note needs to be created.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "subscription_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The identifier of the subscription for which this credit note needs to be created.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "reference_invoice_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The identifier of the invoice against which this Credit Note is issued.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "type" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The credit note type. [Learn more](/docs/api/v2/pcv-1/credit_notes/credit-note-object)\nabout credit note types.\n\n* refundable - Refundable Credit Note\n* store - Store Credit Note\n* adjustment - Adjustment Credit Note\n",
                    "enum" : [ "adjustment", "refundable", "store" ],
                    "example" : null
                  },
                  "currency_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The currency code (ISO 4217 format) for the credit note.\n",
                    "maxLength" : 3,
                    "example" : null
                  },
                  "create_reason_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Reason code for creating the credit note. Must be one from a list of reason codes set in the Chargebee app in **Settings \\> Configure Chargebee \\> Reason Codes \\> Credit Notes \\> Create Credit Note**.\nMust be passed if set as mandatory in the app. The codes are case-sensitive.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "date" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "The date the Credit Note is issued.\n",
                    "example" : null
                  },
                  "status" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The credit note status.\n\n* refund_due - When the credits are yet to be used, or have been partially used.\n* refunded - When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded).\n* voided - When the Credit Note has been cancelled.\n* adjusted - When the Credit Note has been adjusted against an invoice.\n",
                    "enum" : [ "adjusted", "refunded", "refund_due", "voided" ],
                    "example" : null
                  },
                  "total" : {
                    "type" : "integer",
                    "format" : "int64",
                    "default" : 0,
                    "deprecated" : false,
                    "description" : "Credit Note amount in cents.\n",
                    "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.\n",
                    "example" : null
                  },
                  "voided_at" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "Timestamp indicating the date and time this Credit Note gets voided.\n",
                    "example" : null
                  },
                  "sub_total" : {
                    "type" : "integer",
                    "format" : "int64",
                    "deprecated" : false,
                    "description" : "The Credit Note sub-total.\n",
                    "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`.\nIf there is no `round-off amount`\n, it will display `0`\n.\n",
                    "maximum" : 99,
                    "minimum" : -99,
                    "example" : null
                  },
                  "fractional_correction" : {
                    "type" : "integer",
                    "format" : "int64",
                    "deprecated" : false,
                    "description" : "Indicates the fractional correction amount.\n",
                    "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).\nOnly applicable specifically for customers with [billing_address](/docs/api/customers/customer-object#billing_address)\n\n`country`\nas `XI`\n(which is **United Kingdom - Northern Ireland**\n).\n\nWhen you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\nin 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\nthe Brexit configuration, you have the option of setting [billing_address](/docs/api/customers/customer-object#billing_address)\n\n`country`\nas `XI`.\nThat's the code for **United Kingdom - Northern Ireland** .\nThe first two characters of the VAT number in such a case is\n`XI`\nby default. However, if the VAT number was registered in UK, the value should be `GB`.\nSet\n`vat_number_prefix`\nto `GB`\nfor such cases.\n",
                    "maxLength" : 10,
                    "example" : null
                  },
                  "line_items" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for line_items\n",
                    "properties" : {
                      "reference_line_item_id" : {
                        "type" : "array",
                        "description" : "Uniquely identifies a line_item of invoice for which this reversal represents.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 40,
                          "example" : null
                        },
                        "example" : null
                      },
                      "id" : {
                        "type" : "array",
                        "description" : "Uniquely identifies a line_item\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 40,
                          "example" : null
                        },
                        "example" : null
                      },
                      "date_from" : {
                        "type" : "array",
                        "description" : "Start date of this line item.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "unix-time",
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      },
                      "date_to" : {
                        "type" : "array",
                        "description" : "End date of this line item.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "unix-time",
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      },
                      "subscription_id" : {
                        "type" : "array",
                        "description" : "A unique identifier for the subscription this line item belongs to.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "description" : {
                        "type" : "array",
                        "description" : "Description for this line item\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 250,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_amount" : {
                        "type" : "array",
                        "description" : "Unit amount of the line item.\n",
                        "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).\n[Quantity of the recurring item](/docs/api/v2/pcv-1/invoices/invoice-object#line_items_quantity) which is represented by this line item.\n",
                        "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\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`.\nThe value is in major units of the currency. Returned when the `line_item`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "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`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "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`\n, in major units of the currency. Typically equals to `unit_amount_in_decimal`\nx `quantity_in_decimal`.\nReturned when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "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.\n\n* addon -\n  Indicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the [addon](/docs/api/v2/pcv-1/addons/addon-object)\n  id\n* adhoc - Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case\n* plan_setup -\n  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)\n  id\n* plan -\n  Indicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)\n  id\n",
                          "enum" : [ "plan_setup", "plan", "addon", "adhoc" ],
                          "example" : null
                        },
                        "example" : null
                      },
                      "entity_id" : {
                        "type" : "array",
                        "description" : "The identifier of the modelled entity this line item is based on. Will be null for 'adhoc' entity type\n",
                        "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\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "item_level_discount1_amount" : {
                        "type" : "array",
                        "description" : "First item level discount amount\n",
                        "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\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "item_level_discount2_amount" : {
                        "type" : "array",
                        "description" : "Second item level discount amount\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax1_name" : {
                        "type" : "array",
                        "description" : "First tax name\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax1_amount" : {
                        "type" : "array",
                        "description" : "First tax amount\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax2_name" : {
                        "type" : "array",
                        "description" : "Second tax name\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax2_amount" : {
                        "type" : "array",
                        "description" : "Second tax amount\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax3_name" : {
                        "type" : "array",
                        "description" : "Third tax name\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax3_amount" : {
                        "type" : "array",
                        "description" : "Third tax amount\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax4_name" : {
                        "type" : "array",
                        "description" : "Fourth tax name\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax4_amount" : {
                        "type" : "array",
                        "description" : "Fourth tax amount\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax5_name" : {
                        "type" : "array",
                        "description" : "Fifth tax name\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax5_amount" : {
                        "type" : "array",
                        "description" : "Fifth tax amount\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax6_name" : {
                        "type" : "array",
                        "description" : "Sixth tax name\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax6_amount" : {
                        "type" : "array",
                        "description" : "Sixth tax amount\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax7_name" : {
                        "type" : "array",
                        "description" : "Seventh tax name\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax7_amount" : {
                        "type" : "array",
                        "description" : "Seventh tax amount\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax8_name" : {
                        "type" : "array",
                        "description" : "Eighth tax name\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax8_amount" : {
                        "type" : "array",
                        "description" : "Eighth tax amount\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax9_name" : {
                        "type" : "array",
                        "description" : "Ninth tax name\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax9_amount" : {
                        "type" : "array",
                        "description" : "Ninth tax amount\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax10_name" : {
                        "type" : "array",
                        "description" : "Tenth tax name\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax10_amount" : {
                        "type" : "array",
                        "description" : "Tenth tax amount\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.\n",
                          "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\n",
                    "properties" : {
                      "line_item_id" : {
                        "type" : "array",
                        "description" : "Uniquely identifies a line_item\n",
                        "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\n",
                        "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\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_used" : {
                        "type" : "array",
                        "description" : "The number of units purchased in a range.\n",
                        "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`\npricing , or the price of each unit in the tier if the charge model is `tiered`\n/`volume`\npricing.\n",
                        "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`\nof the next lower tier. Returned only when the `line_items.pricing_model`\nis `tiered`\n, `volume`\nor `stairstep`\nand [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis 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. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the `starting_unit_in_decimal`\nof the next higher tier. Returned only when the `line_items.pricing_model`\nis `tiered`\n, `volume`\nor stairstep and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "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`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "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`\nis `tiered`\nor `volume`.\nWhen the `pricing_model`\nis `stairstep`\n, it is the decimal representation of the total price for `line_item`.\nThe value is in major units of the currency. Returned when the `line_item`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "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\n",
                    "properties" : {
                      "line_item_id" : {
                        "type" : "array",
                        "description" : "The unique id of the line item that this deduction is for. Is required when `discounts[entity_type]`\nis `item_level_coupon`\nor `document_level_coupon`\n.\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.\n\n* document_level_coupon -\n  The deduction is due to a coupon applied to the invoice `sub_total`.\n  The coupon id is passed as `entity_id`\n  .\n* item_level_coupon -\n  The deduction is due to a coupon applied to line item. The coupon `id`\n  is passed as `entity_id`\n  .\n* promotional_credits -\n  The deduction is due to a [promotional credit](/docs/api/promotional_credits)\n  applied to the invoice.\n",
                          "enum" : [ "item_level_coupon", "document_level_coupon", "promotional_credits" ],
                          "example" : null
                        },
                        "example" : null
                      },
                      "entity_id" : {
                        "type" : "array",
                        "description" : "When the deduction is due to a `coupon`\n, then this is the `id`\nof the coupon. Is required when `discounts[entity_type]`\nis `item_level_coupon`\nor `document_level_coupon`\n.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "description" : {
                        "type" : "array",
                        "description" : "Description for this deduction.\n",
                        "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)\n.\n",
                        "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\n",
                    "properties" : {
                      "name" : {
                        "type" : "array",
                        "description" : "The name of the tax applied\n",
                        "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",
                        "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\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "description" : {
                        "type" : "array",
                        "description" : "Description of tax\n",
                        "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\n\n* country - The tax jurisdiction is a country\n* special - Special tax jurisdiction.\n* county - The tax jurisdiction is a county\n* state - The tax jurisdiction is a state\n* city - The tax jurisdiction is a city\n* other - Jurisdictions other than the ones listed above.\n* unincorporated - Combined tax of state and county.\n* federal - The tax jurisdiction is a federal\n",
                          "enum" : [ "country", "federal", "state", "county", "city", "special", "unincorporated", "other" ],
                          "example" : null
                        },
                        "example" : null
                      },
                      "juris_name" : {
                        "type" : "array",
                        "description" : "The name of the tax jurisdiction\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 250,
                          "example" : null
                        },
                        "example" : null
                      },
                      "juris_code" : {
                        "type" : "array",
                        "description" : "The tax jurisdiction code\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 250,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "required" : [ "name", "rate" ],
                    "example" : null
                  },
                  "allocations" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for allocations\n",
                    "properties" : {
                      "invoice_id" : {
                        "type" : "array",
                        "description" : "The unique invoice ID for the allocation\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "allocated_amount" : {
                        "type" : "array",
                        "description" : "The allocated amount for the credit note\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "allocated_at" : {
                        "type" : "array",
                        "description" : "Time when the allocation was occurred\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\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 40,
                          "example" : null
                        },
                        "example" : null
                      },
                      "amount" : {
                        "type" : "array",
                        "description" : "Amount of this refund transaction.\n",
                        "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 refund.\n\n* other - Payment Methods other than the above types\n* cash - Cash\n* custom - Custom\n* bank_transfer - Bank Transfer\n* check - Check\n",
                          "enum" : [ "cash", "check", "bank_transfer", "other", "custom", "tamara", "qpay", "blik", "fpx", "wero", "p24" ],
                          "example" : null
                        },
                        "example" : null
                      },
                      "date" : {
                        "type" : "array",
                        "description" : "The date of refund.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "unix-time",
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      },
                      "reference_number" : {
                        "type" : "array",
                        "description" : "Reference number for this refund.\n",
                        "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\n"
                    }
                  },
                  "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.\n",
        "operationId" : "delete_a_credit_note",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "credit-note-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/credit-note-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "comment" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Reason for deleting this transaction. This comment will be added to the associated entity.\n",
                    "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\n"
                    }
                  },
                  "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.\n",
        "operationId" : "retrieve_credit_note_as_pdf",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "credit-note-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/credit-note-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "disposition_type" : {
                    "type" : "string",
                    "default" : "attachment",
                    "deprecated" : false,
                    "description" : "Determines the pdf should be rendered as inline or attachment in the browser.\n\n* attachment - PDF is rendered as attachment in the browser\n* inline - PDF is rendered as inline in the browser\n",
                    "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\n"
                    }
                  },
                  "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.\nTo support cases like TDS and invoice edits, we need to stop auto e-invoice sending and be able to send e-invoices manually.\nThis endpoint schedules e-invoices manually. This operation is not allowed when any of the following condition matches:\n\n* If e-invoicing is not enabled at the site and customer level.\n\n* If there is an e-invoice generated already for the invoice.\n\n* If the **Use automatic e-invoicing** option is selected.\n\n* If there are no generated e-invoices with the `failed` or `skipped` status.\n\n* If the invoice status is `voided` or `pending`.\n\n",
        "operationId" : "send_an_einvoice_for_credit_notes",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "credit-note-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/credit-note-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "credit_note" : {
                      "$ref" : "#/components/schemas/CreditNote",
                      "description" : "Resource object representing credit_note\n"
                    }
                  },
                  "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" : "Use this API to [void a credit note.](https://www.chargebee.com/docs/credit-notes.html#voiding-or-deleting-a-credit-note) A voided credit is a null entity and cannot be used again. A credit note which has already been voided or refunded cannot be voided. An error message will be displayed when you render such credit notes void.  \n**Note:**\nWhen adjustment credit notes are voided, the associated invoice will reflect as NOT PAID, and the amount in the invoice will be recalculated to reflect the amount after considering the voided credit note.\n",
        "operationId" : "void_a_credit_note",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "credit-note-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/credit-note-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "comment" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Reason for deleting this transaction. This comment will be added to the associated entity.\n",
                    "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\n"
                    }
                  },
                  "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 ([refundable](https://www.chargebee.com/docs/credit-notes.html#types-of-credit-notes_refundable-credit-note)) credit note to the [payment source](/docs/api/payment_sources) associated with the [transaction](/docs/api/transactions). Any [linked_tax_withheld_refunds](/docs/api/credit_notes/credit_note-object#linked_tax_withheld_refunds) recorded against the credit note are not refunded.\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" : "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. If not specified, the entire [refundable amount](/docs/api/credit_notes/credit_note-object#amount_available)\nfor this `credit_note`\nis refunded.\n\n**Note:**\nAny [linked_tax_withheld_refunds](/docs/api/credit_notes/credit_note-object#linked_tax_withheld_refunds)\nassociated with the `credit_note`\ncannot be refunded via this operation.\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)\n.\n",
                    "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**.\nMust be passed if set as mandatory in the app. The codes are case-sensitive.\n",
                    "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\n"
                    },
                    "transaction" : {
                      "$ref" : "#/components/schemas/Transaction",
                      "description" : "Resource object representing transaction\n"
                    }
                  },
                  "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" : "**Important**\n\nFor sites where both [legacy and latest](/docs/api/v2/pcv-1/upgrade#retrieving-api-responses-in-latest-api-format) product catalog versions are active, GET API requests return responses in a `compat` format by default. This format works with both latest and legacy Product Catalog.\n\n**Override options:**\n\n* `chargebee-response-schema-type: items` → Return response in latest product catalog format only.\n* `chargebee-response-schema-type: plans_addons` → Return response in legacy product catalog format only.\n\nLists all the Credit Notes.\n",
        "operationId" : "list_credit_notes",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "limit",
          "in" : "query",
          "description" : "The number of resources to be returned.\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`\nto the value of `next_offset`\nobtained in the previous iteration of the API call.\n",
          "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**\n' attribute will be '**true**\n'.\n",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "boolean",
            "default" : false,
            "example" : null
          }
        }, {
          "name" : "id",
          "in" : "query",
          "description" : "optional, string filter\n\nCredit-note id.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*id\\[is\\] = \"CN_123\"*\n",
          "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\n\nThe identifier of the customer this Credit Note belongs to.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*customer_id\\[is\\] = \"4gmiXbsjdm\"*\n",
          "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\n\nTo filter based on subscription_id.\nNOTE: Not to be used if *consolidated invoicing*\nfeature is enabled.\n**Supported operators :**\nis, is_not, starts_with, is_present, in, not_in\n\n**Example →**\n*subscription_id\\[is\\] = \"4gmiXbsjdm\"*\n",
          "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\n\nThe identifier of the invoice against which this Credit Note is issued.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*reference_invoice_id\\[is\\] = \"INVOICE_876\"*\n",
          "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\n\nThe credit note type. Possible values are : adjustment, refundable.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*type\\[is\\] = \"adjustment\"*\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "example" : "adjustment",
            "properties" : {
              "is" : {
                "type" : "string",
                "description" : "* `adjustment` - Adjustment Credit Note\n* `refundable` - Refundable Credit Note\n* `store` - Store Credit Note",
                "enum" : [ "adjustment", "refundable", "store" ],
                "example" : null
              },
              "is_not" : {
                "type" : "string",
                "description" : "* `adjustment` - Adjustment Credit Note\n* `refundable` - Refundable Credit Note\n* `store` - Store Credit Note",
                "enum" : [ "adjustment", "refundable", "store" ],
                "example" : null
              },
              "in" : {
                "type" : "string",
                "description" : "* `adjustment` - Adjustment Credit Note\n* `refundable` - Refundable Credit Note\n* `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\n* `refundable` - Refundable Credit Note\n* `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\n\nThe 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)\nparameter instead\\]. Possible values are : write_off, subscription_change, subscription_cancellation, subscription_pause, chargeback, product_unsatisfactory, service_unsatisfactory, order_change, order_cancellation, waiver, other, fraudulent.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*reason_code\\[is\\] = \"waiver\"*\n",
          "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.\n* `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\n* `subscription_cancellation` - This reason will be set automatically for Credit Notes created during cancel subscription operation\n* `subscription_pause` - This reason will be automatically set to credit notes created during pause/resume subscription operation.\n* `chargeback` - Can be set when you are recording your customer Chargebacks\n* `product_unsatisfactory` - Product Unsatisfactory\n* `service_unsatisfactory` - Service Unsatisfactory\n* `order_change` - Order Change\n* `order_cancellation` - Order Cancellation\n* `waiver` - Waiver\n* `other` - Can be set when none of the above reason codes are applicable\n* `fraudulent` - FRAUDULENT\n",
                "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.\n* `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\n* `subscription_cancellation` - This reason will be set automatically for Credit Notes created during cancel subscription operation\n* `subscription_pause` - This reason will be automatically set to credit notes created during pause/resume subscription operation.\n* `chargeback` - Can be set when you are recording your customer Chargebacks\n* `product_unsatisfactory` - Product Unsatisfactory\n* `service_unsatisfactory` - Service Unsatisfactory\n* `order_change` - Order Change\n* `order_cancellation` - Order Cancellation\n* `waiver` - Waiver\n* `other` - Can be set when none of the above reason codes are applicable\n* `fraudulent` - FRAUDULENT\n",
                "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.\n* `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\n* `subscription_cancellation` - This reason will be set automatically for Credit Notes created during cancel subscription operation\n* `subscription_pause` - This reason will be automatically set to credit notes created during pause/resume subscription operation.\n* `chargeback` - Can be set when you are recording your customer Chargebacks\n* `product_unsatisfactory` - Product Unsatisfactory\n* `service_unsatisfactory` - Service Unsatisfactory\n* `order_change` - Order Change\n* `order_cancellation` - Order Cancellation\n* `waiver` - Waiver\n* `other` - Can be set when none of the above reason codes are applicable\n* `fraudulent` - FRAUDULENT\n",
                "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.\n* `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\n* `subscription_cancellation` - This reason will be set automatically for Credit Notes created during cancel subscription operation\n* `subscription_pause` - This reason will be automatically set to credit notes created during pause/resume subscription operation.\n* `chargeback` - Can be set when you are recording your customer Chargebacks\n* `product_unsatisfactory` - Product Unsatisfactory\n* `service_unsatisfactory` - Service Unsatisfactory\n* `order_change` - Order Change\n* `order_cancellation` - Order Cancellation\n* `waiver` - Waiver\n* `other` - Can be set when none of the above reason codes are applicable\n* `fraudulent` - FRAUDULENT\n",
                "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\n\nReason 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** .\nMust be passed if set as mandatory in the app. The codes are case-sensitive.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*create_reason_code\\[is\\] = \"Other\"*\n",
          "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\n\nThe credit note status. Possible values are : adjusted, refunded, refund_due, voided.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*status\\[is\\] = \"adjusted\"*\n",
          "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.\n* `refunded` - When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded).\n* `refund_due` - When the credits are yet to be used, or have been partially used.\n* `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.\n* `refunded` - When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded).\n* `refund_due` - When the credits are yet to be used, or have been partially used.\n* `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.\n* `refunded` - When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded).\n* `refund_due` - When the credits are yet to be used, or have been partially used.\n* `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.\n* `refunded` - When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded).\n* `refund_due` - When the credits are yet to be used, or have been partially used.\n* `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\n\nThe date the Credit Note is issued.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*date\\[on\\] = \"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" : "total",
          "in" : "query",
          "description" : "optional, in cents filter\n\nCredit Note amount in cents.\n**Supported operators :**\nis, is_not, lt, lte, gt, gte, between\n\n**Example →**\n*total\\[lte\\] = \"1200\"*\n",
          "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\n\nThe price type of the Credit Note. Possible values are : tax_exclusive, tax_inclusive.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*price_type\\[is\\] = \"tax_exclusive\"*\n",
          "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.\n* `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.\n* `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.\n* `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.\n* `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\n\nThe amount allocated to the invoices.\n**Supported operators :**\nis, is_not, lt, lte, gt, gte, between\n\n**Example →**\n*amount_allocated\\[gt\\] = \"1200\"*\n",
          "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\n\nThe refunds issued from this Credit Note.\n**Supported operators :**\nis, is_not, lt, lte, gt, gte, between\n\n**Example →**\n*amount_refunded\\[is\\] = \"130\"*\n",
          "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\n\nThe yet to be used credits of this Credit Note.\n**Supported operators :**\nis, is_not, lt, lte, gt, gte, between\n\n**Example →**\n*amount_available\\[gt\\] = \"1400\"*\n",
          "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\n\nTimestamp indicating the date and time this Credit Note gets voided.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*voided_at\\[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\nTo filter based on updated at. This attribute will be present only if the resource has been updated after 2016-09-28.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*updated_at\\[after\\] = \"1243545465\"*\n",
          "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\n\nSorts based on the specified attribute.\n**Supported attributes :**\ndate\n\n**Supported sort-orders :**\nasc, desc\n\n**Example →**\n*sort_by\\[asc\\] = \"date\"*\n\nThis will sort the result based on the 'date' attribute in ascending(earliest first) order.\n",
          "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\n\nThe subscription channel this object originated from and is maintained in. Possible values are : web, app_store, play_store.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*channel\\[is\\] = \"APP STORE\"*\n",
          "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\n",
          "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`\n, see `message`\n.\n",
                "example" : "failed",
                "properties" : {
                  "is" : {
                    "type" : "string",
                    "description" : "* `scheduled` - Sending the e-invoice to the customer has been scheduled.\n* `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.\n* `in_progress` - The e-invoice has been sent and Chargebee is waiting for confirmation from the receiving entity.\n* `success` - The e-invoice has been successfully delivered to the customer.\n* `failed` - The e-invoice was sent and there was an error due to which it was not delivered.\n* `registered` - The e-invoice was sent and there was an error due to which it was not delivered but got cleared in the IRP.\n* `accepted` - The e-invoice was sent and it was accepted by the receiving entity. The sending entity shall also accept the e-invoice.\n* `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.\n* `message_acknowledgement` - An acknowledgment confirming that the application response was successfully received by the receiving entity.\n* `in_process` - The e-invoice is currently being processed by the receiving entity.\n* `under_query` - The receiving entity has raised a query regarding the e-invoice. Additional information or clarification is required before proceeding.\n* `conditionally_accepted` - The e-invoice has been accepted with conditions.\n* `paid` - The receiving entity has confirmed that the e-invoice has been paid.\n",
                    "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.\n* `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.\n* `in_progress` - The e-invoice has been sent and Chargebee is waiting for confirmation from the receiving entity.\n* `success` - The e-invoice has been successfully delivered to the customer.\n* `failed` - The e-invoice was sent and there was an error due to which it was not delivered.\n* `registered` - The e-invoice was sent and there was an error due to which it was not delivered but got cleared in the IRP.\n* `accepted` - The e-invoice was sent and it was accepted by the receiving entity. The sending entity shall also accept the e-invoice.\n* `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.\n* `message_acknowledgement` - An acknowledgment confirming that the application response was successfully received by the receiving entity.\n* `in_process` - The e-invoice is currently being processed by the receiving entity.\n* `under_query` - The receiving entity has raised a query regarding the e-invoice. Additional information or clarification is required before proceeding.\n* `conditionally_accepted` - The e-invoice has been accepted with conditions.\n* `paid` - The receiving entity has confirmed that the e-invoice has been paid.\n",
                    "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.\n* `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.\n* `in_progress` - The e-invoice has been sent and Chargebee is waiting for confirmation from the receiving entity.\n* `success` - The e-invoice has been successfully delivered to the customer.\n* `failed` - The e-invoice was sent and there was an error due to which it was not delivered.\n* `registered` - The e-invoice was sent and there was an error due to which it was not delivered but got cleared in the IRP.\n* `accepted` - The e-invoice was sent and it was accepted by the receiving entity. The sending entity shall also accept the e-invoice.\n* `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.\n* `message_acknowledgement` - An acknowledgment confirming that the application response was successfully received by the receiving entity.\n* `in_process` - The e-invoice is currently being processed by the receiving entity.\n* `under_query` - The receiving entity has raised a query regarding the e-invoice. Additional information or clarification is required before proceeding.\n* `conditionally_accepted` - The e-invoice has been accepted with conditions.\n* `paid` - The receiving entity has confirmed that the e-invoice has been paid.\n",
                    "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.\n* `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.\n* `in_progress` - The e-invoice has been sent and Chargebee is waiting for confirmation from the receiving entity.\n* `success` - The e-invoice has been successfully delivered to the customer.\n* `failed` - The e-invoice was sent and there was an error due to which it was not delivered.\n* `registered` - The e-invoice was sent and there was an error due to which it was not delivered but got cleared in the IRP.\n* `accepted` - The e-invoice was sent and it was accepted by the receiving entity. The sending entity shall also accept the e-invoice.\n* `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.\n* `message_acknowledgement` - An acknowledgment confirming that the application response was successfully received by the receiving entity.\n* `in_process` - The e-invoice is currently being processed by the receiving entity.\n* `under_query` - The receiving entity has raised a query regarding the e-invoice. Additional information or clarification is required before proceeding.\n* `conditionally_accepted` - The e-invoice has been accepted with conditions.\n* `paid` - The receiving entity has confirmed that the e-invoice has been paid.\n",
                    "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`.\n",
                      "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**Note:**\n\nIf the `credit_note` [type](/docs/api/credit_notes/create-credit-note#type) is `refundable`, then `linked_taxes_withheld.amount` for the [invoice specified](/docs/api/credit_notes/create-credit-note#reference_invoice_id) can also be included in the [total](/docs/api/credit_notes/create-credit-note#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
          }
        } ],
        "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",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "customer_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The unique identifier of the [customer](/docs/api/customers) resource for which the credit note should be created. This is required when standalone credit note has to be created.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "total" : {
                    "type" : "integer",
                    "format" : "int64",
                    "default" : 0,
                    "deprecated" : false,
                    "description" : "Credit Note amount in cents. You can either pass the total parameter or the line_items parameter. Passing both will result in an error.\n",
                    "minimum" : 0,
                    "example" : null
                  },
                  "type" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The credit note type. [Learn more](/docs/api/v2/pcv-1/credit_notes/credit-note-object)\nabout credit note types.\n\n* refundable - Refundable Credit Note\n* store - Store Credit Note\n* adjustment - Adjustment Credit Note\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)\nparameter instead\\].\n\n* waiver - Waiver\n* order_cancellation - Order Cancellation\n* order_change - Order Change\n* product_unsatisfactory - Product Unsatisfactory\n* service_unsatisfactory - Service Unsatisfactory\n* other - Can be set when none of the above reason codes are applicable\n",
                    "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**.\nMust be passed if set as mandatory in the app. The codes are case-sensitive.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "date" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "The date the Credit Note is issued.\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)\n.\n",
                    "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 standalone credit note if Multicurrency is enabled\n",
                    "maxLength" : 3,
                    "example" : null
                  },
                  "comment" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "An internal [comment](/docs/api/comments)\nto 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)\nor any document such as the [Credit Note PDF](/docs/api/credit_notes/retrieve-credit-note-as-pdf)\n.\n",
                    "maxLength" : 300,
                    "example" : null
                  },
                  "line_items" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for line_items\n",
                    "properties" : {
                      "reference_line_item_id" : {
                        "type" : "array",
                        "description" : "Uniquely identifies a line_item\n",
                        "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.\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`.\nThe value is in major units of the currency. Applicable for the line_item when the `pricing_model`\nis `flat_fee`\n, `per_unit`\nor `volume`.\nCan be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "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.\n",
                        "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`.\nApplicable for the `line_item`\nwhen the `pricing_model`\nis `per_unit`\nand `volume`.\nCan be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "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.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      },
                      "date_from" : {
                        "type" : "array",
                        "description" : "Start date of this line item.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "unix-time",
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      },
                      "date_to" : {
                        "type" : "array",
                        "description" : "End date of this line item.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "unix-time",
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      },
                      "description" : {
                        "type" : "array",
                        "description" : "Description for the line item.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 250,
                          "example" : null
                        },
                        "example" : null
                      },
                      "entity_type" : {
                        "type" : "array",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "description" : "* 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\n* 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\n* adhoc - Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case\n",
                          "enum" : [ "plan", "addon", "adhoc" ],
                          "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\n"
                    },
                    "invoice" : {
                      "$ref" : "#/components/schemas/Invoice",
                      "description" : "Resource object representing invoice\n"
                    }
                  },
                  "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/v2/pcv-1/advanced-features#custom-fields) and comment of a [credit note](/docs/api/v2/pcv-1/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/v2/pcv-1/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/v2/pcv-1/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" : "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)\nto 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)\nor any document such as the [Credit Note PDF](/docs/api/credit_notes/retrieve-credit-note-as-pdf)\n.\n",
                    "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\n"
                    }
                  },
                  "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" : "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\n",
                      "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.\n",
        "operationId" : "resend_failed_einvoice_in_credit_notes",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "credit-note-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/credit-note-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "credit_note" : {
                      "$ref" : "#/components/schemas/CreditNote",
                      "description" : "Resource object representing credit_note\n"
                    }
                  },
                  "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)\nrecord from the `credit_note`\n.\n",
        "operationId" : "remove_tax_withheld_refunds_from_a_credit_note",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "credit-note-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/credit-note-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "tax_withheld" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for tax_withheld\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_`.\nFor example, `tax_wh_16BdDXSlbu4uV1Ee6`\n.\n",
                        "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\n"
                    }
                  },
                  "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" : "**Important**\n\nFor sites where both [legacy and latest](/docs/api/v2/pcv-1/upgrade#retrieving-api-responses-in-latest-api-format) product catalog versions are active, GET API requests return responses in a `compat` format by default. This format works with both latest and legacy Product Catalog.\n\n**Override options:**\n\n* `chargebee-response-schema-type: items` → Return response in latest product catalog format only.\n* `chargebee-response-schema-type: plans_addons` → Return response in legacy product catalog format only.\n\nRetrieves the Credit Note identified by the specified Credit Note number.\n",
        "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" : "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\n"
                    }
                  },
                  "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/v2/pcv-1/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" : "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/v2/pcv-1/email_logs) objects for the send request. Each entry describes one email that was sent or attempted.\n",
                      "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.\n",
        "operationId" : "delete_an_unbilled_charge",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "unbilled-charge-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/unbilled-charge-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "unbilled_charge" : {
                      "$ref" : "#/components/schemas/UnbilledCharge",
                      "description" : "Resource object representing unbilled_charge\n"
                    }
                  },
                  "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.\n\nIn the estimate response,\n\n* **estimate.invoice_estimates** is an array of **estimate.invoice_estimate**. This has the details of the invoices that will be generated now.\n\n**Note:**\n\n* This API when invoked does not perform the actual operation. It just generates an estimate.\n* Both *subscription_id* and *customer_id* parameters should not be given at the same time.\n",
        "operationId" : "create_an_estimate_for_unbilled_charges",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "subscription_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Identifier of the subscription for which this estimate needs to be created. Should be given if 'customer_id' is not specified.\n",
                    "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.\n",
                    "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\n"
                    }
                  },
                  "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.\n\nIf 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.\n\nDuring invoice creation, the PO number for the line items will be filled from the subscription's current PO number, if available.\n\nIf no recurring item is present in the created invoice, the invoice will be marked as recurring=false.\n\nIf consolidated invoicing is enabled and the parameter 'customer_id' is passed, multiple invoices can be created based on the following factors.\n\n* Currency\n* PO number if 'Group by PO number' is enabled\n* Shipping address\n* Auto Collection\n* Payment method\n",
        "operationId" : "create_an_invoice_for_unbilled_charges",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "subscription_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Identifier of the subscription for which this invoice needs to be created. Should be specified if 'customer_id' is not specified.\n",
                    "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. .\n",
                    "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\n",
                      "items" : {
                        "$ref" : "#/components/schemas/Invoice",
                        "description" : "Resource object representing invoice\n"
                      },
                      "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.\n",
        "operationId" : "list_unbilled_charges",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "limit",
          "in" : "query",
          "description" : "The number of resources to be returned.\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`\nto the value of `next_offset`\nobtained in the previous iteration of the API call.\n",
          "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**\n' attribute will be '**true**\n'.\n",
          "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.\n",
          "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\n\nA unique identifier for the subscription this charge belongs to.\n**Supported operators :**\nis, is_not, starts_with, is_present, in, not_in\n\n**Example →**\n*subscription_id\\[is\\] = \"5hjdk8nOpd0b12\"*\n",
          "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\n\nA unique identifier for the customer being charged.\n**Supported operators :**\nis, is_not, starts_with, is_present, in, not_in\n\n**Example →**\n*customer_id\\[is\\] = \"5hjdk8nOpd0b12\"*\n",
          "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`.\n",
                      "maxLength" : 1000,
                      "example" : null
                    }
                  },
                  "required" : [ "list" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/unbilled_charges/create" : {
      "post" : {
        "tags" : [ "unbilled_charges" ],
        "summary" : "Create unbilled charges for a subscription",
        "description" : "Create unbilled charges for a subscription using this API.\n",
        "operationId" : "create_unbilled_charges_for_a_subscription",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "subscription_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Identifier of the subscription for which this unbilled charges needs to be created.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "currency_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The currency code (ISO 4217 format) of the unbilled_charge.\n",
                    "maxLength" : 3,
                    "example" : null
                  },
                  "addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "Identifier of the addon. Multiple addons can be passed.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "default" : 1,
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price" : {
                        "type" : "array",
                        "description" : "The price or per-unit-price of the addon. The value depends on the [type of currency](/docs/api/getting-started).  \n**Note:**\n\nFor recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the [addon period](/docs/api/v2/pcv-1/addons/addon-object#period). For example, consider the following details:\n\n* The `unit_price` provided is $10\n* The addon billing period is 1 month.\n* The plan billing period is 3 months.\n* The addon is only billed for $10 on each subscription renewal.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_in_decimal" : {
                        "type" : "array",
                        "description" : "The decimal representation of the quantity of the [non-recurring addon](https://www.chargebee.com/docs/charges.html#non-recurring-addon ).\nProvide the value in major units of the currency. Must be provided when the addon is quantity-based. This parameter can only be passed when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 33,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price_in_decimal" : {
                        "type" : "array",
                        "description" : "When [price overriding](http://chargebee.com/docs/price-override.html )\nis enabled for the site, the price or per-unit price of the [non-recurring addon](https://www.chargebee.com/docs/charges.html#non-recurring-addon )\ncan be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)\nis used by default. Provide the value as a decimal string in major units of the currency. This parameter can only be passed when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      },
                      "date_from" : {
                        "type" : "array",
                        "description" : "The time when the service period for the addon starts.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "unix-time",
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      },
                      "date_to" : {
                        "type" : "array",
                        "description" : "The time when the service period for the addon ends.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "unix-time",
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "charges" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for charges\n",
                    "properties" : {
                      "amount" : {
                        "type" : "array",
                        "description" : "The amount to be charged. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                        "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 ).\nProvide the value in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      },
                      "description" : {
                        "type" : "array",
                        "description" : "Description for this charge\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 250,
                          "example" : null
                        },
                        "example" : null
                      },
                      "taxable" : {
                        "type" : "array",
                        "description" : "The amount to be charged is taxable or not.\n",
                        "items" : {
                          "type" : "boolean",
                          "default" : true,
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax_profile_id" : {
                        "type" : "array",
                        "description" : "Tax profile of the charge.\n",
                        "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)\n.\n",
                        "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)\nto which the item is mapped for calculating the customer's tax in India. Applicable only when both of the following conditions are true:\n\n* [**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.)\n* The [**AvaTax for Sales** integration](https://www.chargebee.com/docs/avalara.html) has been enabled in Chargebee.\n",
                        "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)\n.\n",
                        "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)\nintegration.\n\n* wholesale - Transaction is a sale to another company that will resell your product or service to another consumer\n* retail - Transaction is a sale to an end user\n* consumed - Transaction is for an item that is consumed directly\n* vendor_use - Transaction is for an item that is subject to vendor use tax\n",
                          "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)\nintegration.\n",
                        "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)\nintegration.\n",
                        "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.\n",
                        "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.\n",
                        "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\n",
                    "properties" : {
                      "provider_name" : {
                        "type" : "array",
                        "description" : "Name of the tax provider currently supported.\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 us.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "field_value" : {
                        "type" : "array",
                        "description" : "The value of the corresponding tax field.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  }
                },
                "required" : [ "subscription_id" ],
                "example" : null
              },
              "encoding" : {
                "addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "charges" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "tax_providers_fields" : {
                  "style" : "deepObject",
                  "explode" : true
                }
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "unbilled_charges" : {
                      "type" : "array",
                      "description" : "Resource object representing unbilled_charge\n",
                      "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.\n",
        "operationId" : "list_orders",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "limit",
          "in" : "query",
          "description" : "The number of resources to be returned.\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`\nto the value of `next_offset`\nobtained in the previous iteration of the API call.\n",
          "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**\n' attribute will be '**true**\n'.\n",
          "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.\n",
          "required" : false,
          "deprecated" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "boolean",
            "deprecated" : false,
            "example" : null
          }
        }, {
          "name" : "id",
          "in" : "query",
          "description" : "optional, string filter\n\nUniquely identifies the order. It is the api identifier for the order.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*id\\[is_not\\] = \"890\"*\n",
          "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\n\nThe invoice number which acts as an identifier for invoice and is generated sequentially.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*invoice_id\\[is\\] = \"INVOICE_982\"*\n",
          "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\n\nThe subscription for which the order is created.\n**Supported operators :**\nis, is_not, starts_with\n\n**Example →**\n*subscription_id\\[is_not\\] = \"null\"*\n",
          "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\n\nThe status of this order. Possible values are : new, processing, complete, cancelled, voided, queued, awaiting_shipment, on_hold, delivered, shipped, partially_delivered, returned.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*status\\[is\\] = \"queued\"*\n",
          "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.\n* `processing` - Order is being processed. Applicable only if you are using Chargebee's legacy order management system\n* `complete` - Order has been processed successfully. Applicable only if you are using Chargebee's legacy order management system\n* `cancelled` - Order has been cancelled. Applicable only if you are using Chargebee's legacy order management system\n* `voided` - Order has been voided. Applicable only if you are using Chargebee's legacy order management system\n* `queued` - Order is yet to be processed by any system, these are scheduled orders created by Chargebee\n* `awaiting_shipment` - The order has been picked up by an integration system, and synced to a shipping management platform\n* `on_hold` - The order is paused from being processed.\n* `delivered` - The order has been delivered to the customer.\n* `shipped` - The order has moved from order management system to a shipping system.\n* `partially_delivered` - The order has been partially delivered to the customer.\n* `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.\n* `processing` - Order is being processed. Applicable only if you are using Chargebee's legacy order management system\n* `complete` - Order has been processed successfully. Applicable only if you are using Chargebee's legacy order management system\n* `cancelled` - Order has been cancelled. Applicable only if you are using Chargebee's legacy order management system\n* `voided` - Order has been voided. Applicable only if you are using Chargebee's legacy order management system\n* `queued` - Order is yet to be processed by any system, these are scheduled orders created by Chargebee\n* `awaiting_shipment` - The order has been picked up by an integration system, and synced to a shipping management platform\n* `on_hold` - The order is paused from being processed.\n* `delivered` - The order has been delivered to the customer.\n* `shipped` - The order has moved from order management system to a shipping system.\n* `partially_delivered` - The order has been partially delivered to the customer.\n* `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.\n* `processing` - Order is being processed. Applicable only if you are using Chargebee's legacy order management system\n* `complete` - Order has been processed successfully. Applicable only if you are using Chargebee's legacy order management system\n* `cancelled` - Order has been cancelled. Applicable only if you are using Chargebee's legacy order management system\n* `voided` - Order has been voided. Applicable only if you are using Chargebee's legacy order management system\n* `queued` - Order is yet to be processed by any system, these are scheduled orders created by Chargebee\n* `awaiting_shipment` - The order has been picked up by an integration system, and synced to a shipping management platform\n* `on_hold` - The order is paused from being processed.\n* `delivered` - The order has been delivered to the customer.\n* `shipped` - The order has moved from order management system to a shipping system.\n* `partially_delivered` - The order has been partially delivered to the customer.\n* `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.\n* `processing` - Order is being processed. Applicable only if you are using Chargebee's legacy order management system\n* `complete` - Order has been processed successfully. Applicable only if you are using Chargebee's legacy order management system\n* `cancelled` - Order has been cancelled. Applicable only if you are using Chargebee's legacy order management system\n* `voided` - Order has been voided. Applicable only if you are using Chargebee's legacy order management system\n* `queued` - Order is yet to be processed by any system, these are scheduled orders created by Chargebee\n* `awaiting_shipment` - The order has been picked up by an integration system, and synced to a shipping management platform\n* `on_hold` - The order is paused from being processed.\n* `delivered` - The order has been delivered to the customer.\n* `shipped` - The order has moved from order management system to a shipping system.\n* `partially_delivered` - The order has been partially delivered to the customer.\n* `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\n\nThis is the date on which the order will be delivered to the customer.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*shipping_date\\[on\\] = \"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" : "shipped_at",
          "in" : "query",
          "description" : "optional, timestamp(UTC) in seconds filter\n\nThe time at which the order was shipped.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*shipped_at\\[before\\] = \"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" : "order_type",
          "in" : "query",
          "description" : "optional, enumerated string filter\n\nOrder type. Possible values are : manual, system_generated.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*order_type\\[is_not\\] = \"system_generated\"*\n",
          "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.\n* `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.\n* `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.\n* `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.\n* `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\n\nThe date on which the order will start getting processed.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*order_date\\[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" : "paid_on",
          "in" : "query",
          "description" : "optional, timestamp(UTC) in seconds filter\n\nThe timestamp indicating the date \\& time the order's invoice got paid.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*paid_on\\[before\\] = \"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\nTo filter based on updated at .\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*updated_at\\[after\\] = \"1243545465\"*\n",
          "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\n\nThe time at which the order was created.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*created_at\\[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" : "resent_status",
          "in" : "query",
          "description" : "optional, enumerated string filter\n\nResent order status. Possible values are : fully_resent, partially_resent.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*resent_status\\[is\\] = \"fully_resent\"*\n",
          "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\n* `partially_resent` - Order is Partially resent",
                "enum" : [ "fully_resent", "partially_resent" ],
                "example" : null
              },
              "is_not" : {
                "type" : "string",
                "description" : "* `fully_resent` - Order is Fully resent\n* `partially_resent` - Order is Partially resent",
                "enum" : [ "fully_resent", "partially_resent" ],
                "example" : null
              },
              "in" : {
                "type" : "string",
                "description" : "* `fully_resent` - Order is Fully resent\n* `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\n* `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\n\nOrder is resent order or not. Possible values are : *true, false*\n\n**Supported operators :**\nis\n\n**Example →**\n*is_resent\\[is\\] = \"false\"*\n",
          "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\n\nIf resent order what is the parent order id.\n**Supported operators :**\nis, is_not, starts_with\n\n**Example →**\n*original_order_id\\[is\\] = \"1xRt6ifdr\"*\n",
          "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\n\nSorts based on the specified attribute.\n**Supported attributes :**\ncreated_at, updated_at\n\n**Supported sort-orders :**\nasc, desc\n\n**Example →**\n*sort_by\\[asc\\] = \"created_at\"*\n\nThis will sort the result based on the 'created_at' attribute in ascending(earliest first) order.\n",
          "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`.\n",
                      "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\n\nChargebee no longer supports this endpoint, see [here](https://www.chargebee.com/docs/1.0/manual_orders_deprecate.html)\nfor 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)\nfor additional assistance or if you have concerns about this update.\n",
        "operationId" : "create_an_order",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Uniquely identifies the order. If not given, this will be auto-generated.\n",
                    "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.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "status" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The order status.\n\n* cancelled - Order has been cancelled. Applicable only if you are using Chargebee's legacy order management system\n* new - Order has been created. Applicable only if you are using Chargebee's legacy order management system.\n* voided - Order has been voided. Applicable only if you are using Chargebee's legacy order management system\n* complete - Order has been processed successfully. Applicable only if you are using Chargebee's legacy order management system\n* processing - Order is being processed. Applicable only if you are using Chargebee's legacy order management system\n",
                    "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.\n",
                    "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;.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "note" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The custom note for the order.\n",
                    "maxLength" : 600,
                    "example" : null
                  },
                  "tracking_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The tracking id of the order.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "tracking_url" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The tracking url of the order.\n",
                    "maxLength" : 255,
                    "example" : null
                  },
                  "batch_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Unique id to identify a group of orders.\n",
                    "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\n"
                    }
                  },
                  "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.\n",
        "operationId" : "import_an_order",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Uniquely identifies the order. It is the api identifier for the order.\n\n\\*Order id will always be assigned incrementally from the last generated Order ID.\n\nIf Orders imported has an Order ID which is a string, Chargebee will just validate if the Order ID is unique\n\nRecommendation: 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.\\*\n.\n",
                    "maxLength" : 40,
                    "example" : null
                  },
                  "document_number" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The order's serial number.\n\n*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*\n\n*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'*\n.\n",
                    "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.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "status" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The status of this order.\n\n* shipped - The order has moved from order management system to a shipping system.\n* queued - Order is yet to be processed by any system, these are scheduled orders created by Chargebee\n* on_hold - The order is paused from being processed.\n* returned - The order has been returned after delivery.\n* delivered - The order has been delivered to the customer.\n* awaiting_shipment - The order has been picked up by an integration system, and synced to a shipping management platform\n* cancelled - Order has been cancelled. Applicable only if you are using Chargebee's legacy order management system\n* partially_delivered - The order has been partially delivered to the customer.\n",
                    "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.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "customer_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The customer for which the order is created.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "created_at" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "The time at which the order was created.\n",
                    "example" : null
                  },
                  "order_date" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "The date on which the order will start getting processed.\n",
                    "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.\n",
                    "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.\n\n*Recommendation:\nIf 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.*\n\n*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.*\n.\n",
                    "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;.\n\n\\*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.\n\nIf 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.\\*\n.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "note" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The custom note for the order.\n",
                    "maxLength" : 600,
                    "example" : null
                  },
                  "tracking_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The tracking id of the order.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "tracking_url" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The tracking url of the order.\n",
                    "maxLength" : 255,
                    "example" : null
                  },
                  "batch_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Unique id to identify a group of orders.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "shipment_carrier" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Shipment carrier.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "shipping_cut_off_date" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "The time after which an order becomes unservicable.\n",
                    "example" : null
                  },
                  "delivered_at" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "The time at which the order was delivered.\n",
                    "example" : null
                  },
                  "shipped_at" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "The time at which the order was shipped.\n",
                    "example" : null
                  },
                  "cancelled_at" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "The time at which the order was cancelled.\n",
                    "example" : null
                  },
                  "cancellation_reason" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Cancellation reason.\n\n* shipping_cut_off_passed - The invoice has been paid late and Chargebee cancel's the first order for the invoice.\n* invoice_voided - The invoice for which the order was createed has been voided.\n* alternative_found - Alternative found.\n* others - Other reason\n* order_resent - Order resent\n* product_unsatisfactory - Product unsatisfactory.\n* delivery_date_missed - Delivery date missed.\n* subscription_cancelled - The subsctiption for which the order was created has been cancelled.\n* fraudulent_transaction - Fraudulent transaction.\n* invoice_written_off - The invoice has been completely written off. Orders are generated by Chargebee in cancelled state.\n* product_not_required - Product not required.\n* payment_declined - Payment declined.\n* product_not_available - Product not available.\n* third_party_cancellation - Third party cancellation.\n",
                    "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.\n",
                    "minimum" : 0,
                    "example" : null
                  },
                  "shipping_address" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for shipping_address\n",
                    "properties" : {
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The first name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The last name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "The email address.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "company" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The company name.\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The phone number.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line3" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 3\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "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`\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.\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://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.\n\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n* valid - Address was validated successfully.\n",
                        "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "billing_address" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for billing_address\n",
                    "properties" : {
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The first name of the billing contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The last name of the billing contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "The email address.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "company" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The company name.\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The phone number.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line3" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 3\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "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`\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.\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://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.\n\n* valid - Address was validated successfully.\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n",
                        "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\n"
                    }
                  },
                  "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\n",
        "operationId" : "assign_order_number",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "order-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/order-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "order" : {
                      "$ref" : "#/components/schemas/Order",
                      "description" : "Resource object representing order\n"
                    }
                  },
                  "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.\n",
        "operationId" : "resend_an_order",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "order-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/order-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "shipping_date" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "The date on which the order should be shipped to the customer.\n",
                    "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**.\nMust be passed if set as mandatory in the app. The codes are case-sensitive.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "order_line_items" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for order_line_items\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "The identifier for the order line item.\n",
                        "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\n",
                        "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\n"
                    }
                  },
                  "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\n",
        "operationId" : "reopen_a_cancelled_order",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "order-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/order-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "void_cancellation_credit_notes" : {
                    "type" : "boolean",
                    "deprecated" : false,
                    "description" : "Flag to void credit notes created for cancellation if they are unused.\n",
                    "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\n"
                    }
                  },
                  "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\n",
        "operationId" : "cancel_an_order",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "order-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/order-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "cancellation_reason" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Cancellation reason.\n\n* shipping_cut_off_passed - The invoice has been paid late and Chargebee cancel's the first order for the invoice.\n* alternative_found - Alternative found.\n* others - Other reason\n* product_unsatisfactory - Product unsatisfactory.\n* product_not_required - Product not required.\n* delivery_date_missed - Delivery date missed.\n* invoice_voided - The invoice for which the order was createed has been voided.\n* payment_declined - Payment declined.\n* product_not_available - Product not available.\n* subscription_cancelled - The subsctiption for which the order was created has been cancelled.\n* third_party_cancellation - Third party cancellation.\n* fraudulent_transaction - Fraudulent transaction.\n* order_resent - Order resent\n* invoice_written_off - The invoice has been completely written off. Orders are generated by Chargebee in cancelled state.\n",
                    "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.\n",
                    "maxLength" : 2000,
                    "example" : null
                  },
                  "comment" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Comment, if any, on the refund.\n",
                    "maxLength" : 300,
                    "example" : null
                  },
                  "cancelled_at" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "The time at which the order was cancelled.\n",
                    "example" : null
                  },
                  "credit_note" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for credit_note\n",
                    "properties" : {
                      "total" : {
                        "type" : "integer",
                        "format" : "int64",
                        "default" : 0,
                        "deprecated" : false,
                        "description" : "Credit Note amount in cents.\n",
                        "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\n"
                    }
                  },
                  "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.\n",
        "operationId" : "retrieve_an_order",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "order-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/order-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "order" : {
                      "$ref" : "#/components/schemas/Order",
                      "description" : "Resource object representing order\n"
                    }
                  },
                  "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.\n",
        "operationId" : "update_an_order",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "order-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/order-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "reference_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Reference id is the unique identifier of the order in the shipping/order management application.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "batch_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Unique id to identify a group of orders.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "note" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The custom note for the order.\n",
                    "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.\n",
                    "example" : null
                  },
                  "order_date" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "The order date.\n",
                    "example" : null
                  },
                  "cancelled_at" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "The time at which the order was cancelled.\n",
                    "example" : null
                  },
                  "cancellation_reason" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Cancellation reason.\n\n* shipping_cut_off_passed - The invoice has been paid late and Chargebee cancel's the first order for the invoice.\n* invoice_voided - The invoice for which the order was createed has been voided.\n* alternative_found - Alternative found.\n* others - Other reason\n* order_resent - Order resent\n* product_unsatisfactory - Product unsatisfactory.\n* delivery_date_missed - Delivery date missed.\n* subscription_cancelled - The subsctiption for which the order was created has been cancelled.\n* fraudulent_transaction - Fraudulent transaction.\n* invoice_written_off - The invoice has been completely written off. Orders are generated by Chargebee in cancelled state.\n* product_not_required - Product not required.\n* payment_declined - Payment declined.\n* product_not_available - Product not available.\n* third_party_cancellation - Third party cancellation.\n",
                    "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.\n",
                    "example" : null
                  },
                  "delivered_at" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "The time at which the order was delivered.\n",
                    "example" : null
                  },
                  "tracking_url" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The tracking url of the order.\n",
                    "maxLength" : 255,
                    "example" : null
                  },
                  "tracking_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The tracking id of the order.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "shipment_carrier" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The carrier used to ship the goods to the customer. Ex:- FedEx.\n",
                    "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;.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "status" : {
                    "type" : "string",
                    "default" : "new",
                    "deprecated" : false,
                    "description" : "The order status.\n\n* voided - Order has been voided. Applicable only if you are using Chargebee's legacy order management system\n* complete - Order has been processed successfully. Applicable only if you are using Chargebee's legacy order management system\n* shipped - The order has moved from order management system to a shipping system.\n* processing - Order is being processed. Applicable only if you are using Chargebee's legacy order management system\n* queued - Order is yet to be processed by any system, these are scheduled orders created by Chargebee\n* on_hold - The order is paused from being processed.\n* new - Order has been created. Applicable only if you are using Chargebee's legacy order management system.\n* returned - The order has been returned after delivery.\n* delivered - The order has been delivered to the customer.\n* awaiting_shipment - The order has been picked up by an integration system, and synced to a shipping management platform\n* cancelled - Order has been cancelled. Applicable only if you are using Chargebee's legacy order management system\n* partially_delivered - The order has been partially delivered to the customer.\n",
                    "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\n",
                    "properties" : {
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The first name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The last name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "The email address.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "company" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The company name.\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The phone number.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line3" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 3\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "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`\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.\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://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.\n\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n* valid - Address was validated successfully.\n",
                        "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "order_line_items" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for order_line_items\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "The identifier for the order line item.\n",
                        "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\n\n* shipped - The order line item has been shipped.\n* returned - The order has been returned after delivery.\n* queued - Not processed for shipping yet.\n* awaiting_shipment - Moved to shipping platform.\n* on_hold - The delivery has been moved to \"On hold\" status.\n* partially_delivered - The order has been partially delivered to the customer.\n* cancelled - The order has been returned after delivery.\n* delivered - The order line item has been delivered.\n",
                          "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\n",
                        "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\n"
                    }
                  },
                  "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/v2/pcv-1/orders/import-an-order)\n.Delete does not happen if the order was refunded. It goes through if order refund was initiated and is in \"refund_due\" state.\n",
        "operationId" : "delete_an_imported_order",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "order-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/order-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "order" : {
                      "$ref" : "#/components/schemas/Order",
                      "description" : "Resource object representing order\n"
                    }
                  },
                  "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\n",
        "operationId" : "create_a_refundable_credit_note",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "order-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/order-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "customer_notes" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The Customer Notes to be filled in the Credit Notes created to capture this refund detail.\n",
                    "maxLength" : 2000,
                    "example" : null
                  },
                  "comment" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Comment, if any, on the refund.\n",
                    "maxLength" : 300,
                    "example" : null
                  },
                  "credit_note" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for credit_note\n",
                    "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)\nparameter instead\\]\n\n* product_unsatisfactory - Product Unsatisfactory\n* chargeback - Can be set when you are recording your customer Chargebacks\n* service_unsatisfactory - Service Unsatisfactory\n* write_off -\n  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)\n  operation.\n* subscription_change -\n  This reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html)\n  is enabled\n* fraudulent - FRAUDULENT\n* other - Can be set when none of the above reason codes are applicable\n* subscription_pause - This reason will be automatically set to credit notes created during pause/resume subscription operation.\n* waiver - Waiver\n* order_cancellation - Order Cancellation\n* order_change - Order Change\n* subscription_cancellation - This reason will be set automatically for Credit Notes created during cancel subscription operation\n",
                        "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.\n",
                        "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\n"
                    }
                  },
                  "required" : [ "order" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/gifts/{gift-id}/cancel" : {
      "post" : {
        "tags" : [ "gifts" ],
        "summary" : "Cancel a gift",
        "description" : "This API allows to cancel gifts. Only gift in 'scheduled' and 'unclaimed' states can be cancelled.\n",
        "operationId" : "cancel_a_gift",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "gift-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/gift-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "gift" : {
                      "$ref" : "#/components/schemas/Gift",
                      "description" : "Resource object representing gift\n"
                    },
                    "subscription" : {
                      "$ref" : "#/components/schemas/Subscription",
                      "description" : "Resource object representing subscription\n"
                    }
                  },
                  "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" : "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).\n",
                    "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).\n",
                    "maxLength" : 250,
                    "example" : null
                  },
                  "gift_receiver" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for gift_receiver.\n",
                    "properties" : {
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "The email address of the gift recipient. Must be a valid email address.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "First name of the recipient.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Last name of the recipient.\n",
                        "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\n"
                    },
                    "subscription" : {
                      "$ref" : "#/components/schemas/Subscription",
                      "description" : "Resource object representing subscription\n"
                    }
                  },
                  "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.\n",
        "operationId" : "list_gifts",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "limit",
          "in" : "query",
          "description" : "The number of resources to be returned.\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`\nto the value of `next_offset`\nobtained in the previous iteration of the API call.\n",
          "required" : false,
          "deprecated" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "maxLength" : 1000,
            "example" : null
          }
        }, {
          "name" : "status",
          "in" : "query",
          "description" : "optional, enumerated string filter\n\nStatus of the gift. Possible values are : scheduled, unclaimed, claimed, cancelled, expired.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*status\\[is\\] = \"claimed\"*\n",
          "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.\n* `unclaimed` - Gift is not yet claimed and is ready to be claimed.\n* `claimed` - Gift is claimed.\n* `cancelled` - Gift is cancelled.\n* `expired` - Gift is expired.",
                "enum" : [ "scheduled", "unclaimed", "claimed", "cancelled", "expired" ],
                "example" : null
              },
              "is_not" : {
                "type" : "string",
                "description" : "* `scheduled` - Gift has been scheduled.\n* `unclaimed` - Gift is not yet claimed and is ready to be claimed.\n* `claimed` - Gift is claimed.\n* `cancelled` - Gift is cancelled.\n* `expired` - Gift is expired.",
                "enum" : [ "scheduled", "unclaimed", "claimed", "cancelled", "expired" ],
                "example" : null
              },
              "in" : {
                "type" : "string",
                "description" : "* `scheduled` - Gift has been scheduled.\n* `unclaimed` - Gift is not yet claimed and is ready to be claimed.\n* `claimed` - Gift is claimed.\n* `cancelled` - Gift is cancelled.\n* `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.\n* `unclaimed` - Gift is not yet claimed and is ready to be claimed.\n* `claimed` - Gift is claimed.\n* `cancelled` - Gift is cancelled.\n* `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\n",
          "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.\n",
                "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.\n",
                "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\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "properties" : {
              "customer_id" : {
                "type" : "object",
                "deprecated" : false,
                "description" : "Gifter customer id.\n",
                "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`.\n",
                      "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" : [ "gifts" ],
        "summary" : "Create a gift",
        "description" : "**Note:**\nThis operation optionally supports 3DS verification flow. To achieve the same, create the [Payment Intent](/docs/api/getting-started)\nand pass it as input parameter to this API.\n\nCreates a gift subscription with the gifter and receiver. Only plans marked as gift plans can be used to create gift subscription. It may also have addons and coupons. A gift is initially created in '**scheduled** ' state and the gift subscription will be created in '**future**' state and invoiced immediately.\n\nTerm start and term end dates are determined based on whether the gift is claimed. Before claim, term start date is the subscription start date. Term end date occurs at the end of the plan's frequency. Once the gift is claimed, the gift claim date becomes the term start date and the term end date will be set as the end of the plan's frequency.\n",
        "operationId" : "create_a_gift",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "scheduled_at" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "Indicates the date on which the gift notification is sent to the receiver. If not passed, the receiver is notified immediately.\n",
                    "example" : null
                  },
                  "auto_claim" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "When `true`\n, the claim happens automatically. When not passed, the default value in the site settings is used.\n",
                    "example" : null
                  },
                  "no_expiry" : {
                    "type" : "boolean",
                    "deprecated" : false,
                    "description" : "When `true`\n, indicates that the gift does not expire. Do not pass or pass as `false`\nwhen `auto_claim`\nis set.\n.\n",
                    "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`.\nIf the gift is not claimed within `claim_expiry_date`\n, it will expire and the subscription will move to `cancelled`\nstate. When not passed, the value specified in the site settings will be used.\nPass as `NULL`\nor do not pass when `auto_claim`\nor `no_expiry`\nare set.\n",
                    "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.\n",
                    "items" : {
                      "type" : "string",
                      "deprecated" : false,
                      "maxLength" : 100,
                      "example" : null
                    },
                    "example" : null
                  },
                  "gifter" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for gifter\n",
                    "properties" : {
                      "customer_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Gifter customer id.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "signature" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Gifter sign-off name\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "note" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Personalized message for the gift.\n",
                        "maxLength" : 500,
                        "example" : null
                      },
                      "payment_src_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Identifier of the payment source\n",
                        "maxLength" : 40,
                        "example" : null
                      }
                    },
                    "required" : [ "customer_id", "signature" ],
                    "example" : null
                  },
                  "gift_receiver" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for gift_receiver\n",
                    "properties" : {
                      "customer_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Receiver customer id.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "First name of the receiver as given by the gifter.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Last name of the receiver as given by the gifter,\n",
                        "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.\n",
                        "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\n",
                    "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.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "gateway_account_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The gateway account used for performing the 3DS flow.\n",
                        "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)\nto find out the gateway-specific gw_token format. Applicable when you are using gateway APIs directly for completing the 3DS flow.\n",
                        "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.\n\n* card - card\n* twint - Payments made via Twint\n* swish - Payments made via Swish\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* thai_qr - Payments made via Thai QR.\n* go_pay - Payments made via GoPay\n* google_pay - google_pay\n* trustly - Trustly\n* naver_pay - Payments made via Naver Pay.\n* stablecoin - Payments made via Stablecoin.\n* paypal_express_checkout - paypal_express_checkout\n* pix - Pix\n* venmo - Venmo\n* klarna_pay_now - Klarna Pay Now\n* alipay - Payments made via Alipay.\n* tamara - Payments made via Tamara.\n* ideal - ideal\n* picpay - Payments made via PicPay.\n* pay_to - PayTo\n* ovo - Payments made via OVO.\n* boleto - boleto\n* pay_co - Payments made via PayCo\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* alipay_hk - Payments made via Alipay HK.\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* mercado_pago - Payments made via Mercado Pago.\n* p24 - Payments made via Przelewy24 (P24).\n* electronic_payment_standard - Electronic Payment Standard\n* direct_debit - direct_debit\n* sepa_instant_transfer - Sepa Instant Transfer\n* bancontact - bancontact\n* wero - Payments made via Wero.\n* pay_by_bank - Pay By Bank\n* touch_n_go - Payments made via Touch 'n Go.\n* apple_pay - apple_pay\n* qpay - Payments made via Qpay.\n* online_banking_poland - Online Banking Poland\n* gcash - Payments made via GCash.\n* nupay - Payments made via NuPay.\n* giropay - giropay\n* momo - Payments made via MoMo.\n* sofort - sofort\n* amazon_payments - Amazon Payments\n* affirm_pay - Payments made via Affirm Pay.\n* kakao_pay - Payments made via Kakao Pay.\n* fpx - Payments made via FPX.\n* blik - Payments made via BLIK.\n* dana - Payments made via Dana.\n* south_korean_cards - Payments made via South Korean Cards\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.\n",
                        "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).\n\n  * `payer`: User related information.\n    * `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).\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n    * `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.\n* `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.\n\n  * `fraud`: Fraud identification related information.\n    * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n* `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.\n\n  * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.\n* `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.\n\n  * `payer`: User related information.\n    * `document`: Document is the user's identification number based on their country.\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "shipping_address" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for shipping_address\n",
                    "properties" : {
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The first name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The last name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "The email address.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "company" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The company name.\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The phone number.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line3" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 3\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n).\n",
                        "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`\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.\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://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.\n\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n* valid - Address was validated successfully.\n",
                        "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "subscription" : {
                    "type" : "object",
                    "additionalProperties" : true,
                    "deprecated" : false,
                    "description" : "Parameters for subscription\n",
                    "properties" : {
                      "plan_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Identifier of the plan for this subscription\n",
                        "maxLength" : 100,
                        "example" : null
                      },
                      "plan_quantity" : {
                        "type" : "integer",
                        "format" : "int32",
                        "default" : 1,
                        "deprecated" : false,
                        "description" : "Plan quantity for this subscription\n",
                        "minimum" : 1,
                        "example" : null
                      },
                      "plan_quantity_in_decimal" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Plan Quantity for this subscription in Multi Decimal\n",
                        "maxLength" : 33,
                        "example" : null
                      }
                    },
                    "required" : [ "plan_id" ],
                    "example" : null
                  },
                  "addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "Identifier of the addon. Multiple addons can be passed.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "default" : 1,
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_in_decimal" : {
                        "type" : "array",
                        "description" : "The decimal representation of the quantity of the addon. Returned for quantity-based plans when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 33,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  }
                },
                "example" : null
              },
              "encoding" : {
                "addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "gift_receiver" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "gifter" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "payment_intent" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "shipping_address" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "subscription" : {
                  "style" : "deepObject",
                  "explode" : true
                }
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "gift" : {
                      "$ref" : "#/components/schemas/Gift",
                      "description" : "Resource object representing gift\n"
                    },
                    "subscription" : {
                      "$ref" : "#/components/schemas/Subscription",
                      "description" : "Resource object representing subscription\n"
                    },
                    "invoice" : {
                      "$ref" : "#/components/schemas/Invoice",
                      "description" : "Resource object representing invoice\n"
                    }
                  },
                  "required" : [ "gift", "subscription" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/gifts/{gift-id}" : {
      "get" : {
        "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.\n",
        "operationId" : "retrieve_a_gift",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "gift-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/gift-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "gift" : {
                      "$ref" : "#/components/schemas/Gift",
                      "description" : "Resource object representing gift\n"
                    },
                    "subscription" : {
                      "$ref" : "#/components/schemas/Subscription",
                      "description" : "Resource object representing subscription\n"
                    }
                  },
                  "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.\n",
        "operationId" : "claim_a_gift",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "gift-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/gift-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "gift" : {
                      "$ref" : "#/components/schemas/Gift",
                      "description" : "Resource object representing gift\n"
                    },
                    "subscription" : {
                      "$ref" : "#/components/schemas/Subscription",
                      "description" : "Resource object representing subscription\n"
                    }
                  },
                  "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" : "limit",
          "in" : "query",
          "description" : "The number of resources to be returned.\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`\nto the value of `next_offset`\nobtained in the previous iteration of the API call.\n",
          "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**\n' attribute will be '**true**\n'.\n",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "boolean",
            "default" : false,
            "example" : null
          }
        }, {
          "name" : "id",
          "in" : "query",
          "description" : "optional, string filter\n\nUniquely identifies the transaction.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*id\\[is\\] = \"txn_88ybdbsnvf2\"*\n",
          "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\n\nIdentifier of the customer for which this transaction is made.\n**Supported operators :**\nis, is_not, starts_with, is_present, in, not_in\n\n**Example →**\n*customer_id\\[is\\] = \"5hjdk8nOpd\"*\n",
          "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\n\nIdentifier of the subscription for which this transaction is made.\n**Supported operators :**\nis, is_not, starts_with, is_present, in, not_in\n\n**Example →**\n*subscription_id\\[is\\] = \"5hjdk8nOpd\"*\n",
          "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\n\nTo filter based on Transaction payment source id.\n**Supported operators :**\nis, is_not, starts_with, is_present, in, not_in\n\n**Example →**\n*payment_source_id\\[is\\] = \"pm_3Nl8XXUQUXDVFa2\"*\n",
          "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\n\nThe 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.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*payment_method\\[is\\] = \"card\"*\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "example" : "card",
            "properties" : {
              "is" : {
                "type" : "string",
                "description" : "* `card` - Card\n* `cash` - Cash\n* `check` - Check\n* `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).\n* `bank_transfer` - Bank Transfer\n* `amazon_payments` - Amazon Payments\n* `paypal_express_checkout` - Paypal Express Checkout\n* `direct_debit` - Direct Debit\n* `alipay` - Alipay\n* `unionpay` - Unionpay\n* `apple_pay` - Apple Pay\n* `wechat_pay` - WeChat Pay\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `ideal` - IDEAL\n* `google_pay` - Google Pay\n* `sofort` - Sofort\n* `bancontact` - Bancontact\n* `giropay` - giropay\n* `dotpay` - Dotpay\n* `other` - Payment Methods other than the above types\n* `app_store` - **(Deprecated)** App Store\n* `upi` - upi\n* `netbanking_emandates` - netbanking_emandates\n* `play_store` - **(Deprecated)** Play Store\n* `custom` - Custom\n* `boleto` - boleto\n* `venmo` - Venmo\n* `pay_to` - PayTo\n* `faster_payments` - Faster Payments\n* `sepa_instant_transfer` - Sepa Instant Transfer\n* `automated_bank_transfer` - Automated Bank Transfer\n* `klarna_pay_now` - Klarna Pay Now\n* `online_banking_poland` - Online Banking Poland\n* `payconiq_by_bancontact` - Payconiq by Bancontact\n* `electronic_payment_standard` - Payments made via Electronic Payment Standard.\n* `kbc_payment_button` - Payments made via KBC Payment Button.\n* `pay_by_bank` - Payments made via Pay By Bank.\n* `trustly` - Payments made via Trustly.\n* `stablecoin` - Stablecoin\n* `kakao_pay` - Kakao Pay\n* `naver_pay` - Naver Pay\n* `revolut_pay` - Revolut Pay\n* `cash_app_pay` - Cash App Pay\n* `pix` - Payments made via Pix\n* `twint` - Twint\n* `go_pay` - Go Pay\n* `grab_pay` - Grab Pay\n* `pay_co` - Pay Co\n* `after_pay` - After Pay\n* `swish` - Swish\n* `payme` - PayMe\n* `klarna` - Payments made via Klarna\n* `alipay_hk` - Alipay HK\n* `paypay` - PayPay\n* `gcash` - GCash\n* `south_korean_cards` - Payments made via South Korean Cards\n* `paynow` - Payments made via PayNow\n* `bizum` - Payments made via Bizum\n* `promptpay` - Payments made via PromptPay\n* `dana` - Dana\n* `touch_n_go` - Touch 'n Go\n* `tamara` - Tamara\n* `qpay` - Qpay\n* `ovo` - OVO\n* `momo` - MoMo\n* `mercado_pago` - Mercado Pago\n* `nequi` - Nequi\n* `nupay` - NuPay\n* `picpay` - PicPay\n* `thai_qr` - Thai QR\n* `blik` - BLIK\n* `fpx` - FPX\n* `wero` - Wero\n* `p24` - Przelewy24 (P24)\n* `affirm_pay` - Affirm Pay\n* `rakuten_pay` - Rakuten Pay\n",
                "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\n* `cash` - Cash\n* `check` - Check\n* `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).\n* `bank_transfer` - Bank Transfer\n* `amazon_payments` - Amazon Payments\n* `paypal_express_checkout` - Paypal Express Checkout\n* `direct_debit` - Direct Debit\n* `alipay` - Alipay\n* `unionpay` - Unionpay\n* `apple_pay` - Apple Pay\n* `wechat_pay` - WeChat Pay\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `ideal` - IDEAL\n* `google_pay` - Google Pay\n* `sofort` - Sofort\n* `bancontact` - Bancontact\n* `giropay` - giropay\n* `dotpay` - Dotpay\n* `other` - Payment Methods other than the above types\n* `app_store` - **(Deprecated)** App Store\n* `upi` - upi\n* `netbanking_emandates` - netbanking_emandates\n* `play_store` - **(Deprecated)** Play Store\n* `custom` - Custom\n* `boleto` - boleto\n* `venmo` - Venmo\n* `pay_to` - PayTo\n* `faster_payments` - Faster Payments\n* `sepa_instant_transfer` - Sepa Instant Transfer\n* `automated_bank_transfer` - Automated Bank Transfer\n* `klarna_pay_now` - Klarna Pay Now\n* `online_banking_poland` - Online Banking Poland\n* `payconiq_by_bancontact` - Payconiq by Bancontact\n* `electronic_payment_standard` - Payments made via Electronic Payment Standard.\n* `kbc_payment_button` - Payments made via KBC Payment Button.\n* `pay_by_bank` - Payments made via Pay By Bank.\n* `trustly` - Payments made via Trustly.\n* `stablecoin` - Stablecoin\n* `kakao_pay` - Kakao Pay\n* `naver_pay` - Naver Pay\n* `revolut_pay` - Revolut Pay\n* `cash_app_pay` - Cash App Pay\n* `pix` - Payments made via Pix\n* `twint` - Twint\n* `go_pay` - Go Pay\n* `grab_pay` - Grab Pay\n* `pay_co` - Pay Co\n* `after_pay` - After Pay\n* `swish` - Swish\n* `payme` - PayMe\n* `klarna` - Payments made via Klarna\n* `alipay_hk` - Alipay HK\n* `paypay` - PayPay\n* `gcash` - GCash\n* `south_korean_cards` - Payments made via South Korean Cards\n* `paynow` - Payments made via PayNow\n* `bizum` - Payments made via Bizum\n* `promptpay` - Payments made via PromptPay\n* `dana` - Dana\n* `touch_n_go` - Touch 'n Go\n* `tamara` - Tamara\n* `qpay` - Qpay\n* `ovo` - OVO\n* `momo` - MoMo\n* `mercado_pago` - Mercado Pago\n* `nequi` - Nequi\n* `nupay` - NuPay\n* `picpay` - PicPay\n* `thai_qr` - Thai QR\n* `blik` - BLIK\n* `fpx` - FPX\n* `wero` - Wero\n* `p24` - Przelewy24 (P24)\n* `affirm_pay` - Affirm Pay\n* `rakuten_pay` - Rakuten Pay\n",
                "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\n* `cash` - Cash\n* `check` - Check\n* `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).\n* `bank_transfer` - Bank Transfer\n* `amazon_payments` - Amazon Payments\n* `paypal_express_checkout` - Paypal Express Checkout\n* `direct_debit` - Direct Debit\n* `alipay` - Alipay\n* `unionpay` - Unionpay\n* `apple_pay` - Apple Pay\n* `wechat_pay` - WeChat Pay\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `ideal` - IDEAL\n* `google_pay` - Google Pay\n* `sofort` - Sofort\n* `bancontact` - Bancontact\n* `giropay` - giropay\n* `dotpay` - Dotpay\n* `other` - Payment Methods other than the above types\n* `app_store` - **(Deprecated)** App Store\n* `upi` - upi\n* `netbanking_emandates` - netbanking_emandates\n* `play_store` - **(Deprecated)** Play Store\n* `custom` - Custom\n* `boleto` - boleto\n* `venmo` - Venmo\n* `pay_to` - PayTo\n* `faster_payments` - Faster Payments\n* `sepa_instant_transfer` - Sepa Instant Transfer\n* `automated_bank_transfer` - Automated Bank Transfer\n* `klarna_pay_now` - Klarna Pay Now\n* `online_banking_poland` - Online Banking Poland\n* `payconiq_by_bancontact` - Payconiq by Bancontact\n* `electronic_payment_standard` - Payments made via Electronic Payment Standard.\n* `kbc_payment_button` - Payments made via KBC Payment Button.\n* `pay_by_bank` - Payments made via Pay By Bank.\n* `trustly` - Payments made via Trustly.\n* `stablecoin` - Stablecoin\n* `kakao_pay` - Kakao Pay\n* `naver_pay` - Naver Pay\n* `revolut_pay` - Revolut Pay\n* `cash_app_pay` - Cash App Pay\n* `pix` - Payments made via Pix\n* `twint` - Twint\n* `go_pay` - Go Pay\n* `grab_pay` - Grab Pay\n* `pay_co` - Pay Co\n* `after_pay` - After Pay\n* `swish` - Swish\n* `payme` - PayMe\n* `klarna` - Payments made via Klarna\n* `alipay_hk` - Alipay HK\n* `paypay` - PayPay\n* `gcash` - GCash\n* `south_korean_cards` - Payments made via South Korean Cards\n* `paynow` - Payments made via PayNow\n* `bizum` - Payments made via Bizum\n* `promptpay` - Payments made via PromptPay\n* `dana` - Dana\n* `touch_n_go` - Touch 'n Go\n* `tamara` - Tamara\n* `qpay` - Qpay\n* `ovo` - OVO\n* `momo` - MoMo\n* `mercado_pago` - Mercado Pago\n* `nequi` - Nequi\n* `nupay` - NuPay\n* `picpay` - PicPay\n* `thai_qr` - Thai QR\n* `blik` - BLIK\n* `fpx` - FPX\n* `wero` - Wero\n* `p24` - Przelewy24 (P24)\n* `affirm_pay` - Affirm Pay\n* `rakuten_pay` - Rakuten Pay\n",
                "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\n* `cash` - Cash\n* `check` - Check\n* `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).\n* `bank_transfer` - Bank Transfer\n* `amazon_payments` - Amazon Payments\n* `paypal_express_checkout` - Paypal Express Checkout\n* `direct_debit` - Direct Debit\n* `alipay` - Alipay\n* `unionpay` - Unionpay\n* `apple_pay` - Apple Pay\n* `wechat_pay` - WeChat Pay\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `ideal` - IDEAL\n* `google_pay` - Google Pay\n* `sofort` - Sofort\n* `bancontact` - Bancontact\n* `giropay` - giropay\n* `dotpay` - Dotpay\n* `other` - Payment Methods other than the above types\n* `app_store` - **(Deprecated)** App Store\n* `upi` - upi\n* `netbanking_emandates` - netbanking_emandates\n* `play_store` - **(Deprecated)** Play Store\n* `custom` - Custom\n* `boleto` - boleto\n* `venmo` - Venmo\n* `pay_to` - PayTo\n* `faster_payments` - Faster Payments\n* `sepa_instant_transfer` - Sepa Instant Transfer\n* `automated_bank_transfer` - Automated Bank Transfer\n* `klarna_pay_now` - Klarna Pay Now\n* `online_banking_poland` - Online Banking Poland\n* `payconiq_by_bancontact` - Payconiq by Bancontact\n* `electronic_payment_standard` - Payments made via Electronic Payment Standard.\n* `kbc_payment_button` - Payments made via KBC Payment Button.\n* `pay_by_bank` - Payments made via Pay By Bank.\n* `trustly` - Payments made via Trustly.\n* `stablecoin` - Stablecoin\n* `kakao_pay` - Kakao Pay\n* `naver_pay` - Naver Pay\n* `revolut_pay` - Revolut Pay\n* `cash_app_pay` - Cash App Pay\n* `pix` - Payments made via Pix\n* `twint` - Twint\n* `go_pay` - Go Pay\n* `grab_pay` - Grab Pay\n* `pay_co` - Pay Co\n* `after_pay` - After Pay\n* `swish` - Swish\n* `payme` - PayMe\n* `klarna` - Payments made via Klarna\n* `alipay_hk` - Alipay HK\n* `paypay` - PayPay\n* `gcash` - GCash\n* `south_korean_cards` - Payments made via South Korean Cards\n* `paynow` - Payments made via PayNow\n* `bizum` - Payments made via Bizum\n* `promptpay` - Payments made via PromptPay\n* `dana` - Dana\n* `touch_n_go` - Touch 'n Go\n* `tamara` - Tamara\n* `qpay` - Qpay\n* `ovo` - OVO\n* `momo` - MoMo\n* `mercado_pago` - Mercado Pago\n* `nequi` - Nequi\n* `nupay` - NuPay\n* `picpay` - PicPay\n* `thai_qr` - Thai QR\n* `blik` - BLIK\n* `fpx` - FPX\n* `wero` - Wero\n* `p24` - Przelewy24 (P24)\n* `affirm_pay` - Affirm Pay\n* `rakuten_pay` - Rakuten Pay\n",
                "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\n\nGateway 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.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*gateway\\[is_not\\] = \"stripe\"*\n",
          "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\n\nThe gateway account used for this transaction.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*gateway_account_id\\[is\\] = \"gw_3Nl9BNeQ7438Ks1\"*\n",
          "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\n\nThe id with which this transaction is referred in gateway.\n**Supported operators :**\nis, is_not, starts_with\n\n**Example →**\n*id_at_gateway\\[is_not\\] = \"txn_5678HJS89900\"*\n",
          "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\n\nThe reference number for this transaction. For example, the check number when [payment_method](/docs/api/transactions/transaction-object#payment_method)\n= `check`\n.\n**Supported operators :**\nis, is_not, starts_with, is_present\n\n**Example →**\n*reference_number\\[is\\] = \"cus_u239732\"*\n",
          "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\n\nType of the transaction. Possible values are : authorization, payment, refund, payment_reversal.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*type\\[is\\] = \"payment\"*\n",
          "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).\n* `payment` - The transaction represents capture of [amount](transactions#transaction_amount) from the customer's [payment_source](payment_sources).\n* `refund` - The transaction represents a refund of [amount](transactions#transaction_amount) to the customer's [payment_source](payment_sources).\n* `payment_reversal` - Indicates a reversal transaction.\n",
                "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).\n* `payment` - The transaction represents capture of [amount](transactions#transaction_amount) from the customer's [payment_source](payment_sources).\n* `refund` - The transaction represents a refund of [amount](transactions#transaction_amount) to the customer's [payment_source](payment_sources).\n* `payment_reversal` - Indicates a reversal transaction.\n",
                "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).\n* `payment` - The transaction represents capture of [amount](transactions#transaction_amount) from the customer's [payment_source](payment_sources).\n* `refund` - The transaction represents a refund of [amount](transactions#transaction_amount) to the customer's [payment_source](payment_sources).\n* `payment_reversal` - Indicates a reversal transaction.\n",
                "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).\n* `payment` - The transaction represents capture of [amount](transactions#transaction_amount) from the customer's [payment_source](payment_sources).\n* `refund` - The transaction represents a refund of [amount](transactions#transaction_amount) to the customer's [payment_source](payment_sources).\n* `payment_reversal` - Indicates a reversal transaction.\n",
                "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\n\nIndicates when this transaction occurred.\nWe recommend using this filter when listing transactions for better query performance. It is advisable when using this filter, to pass the `sort_by`\ninput parameter as `date`\nfor a faster response.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*date\\[before\\] = \"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" : "amount",
          "in" : "query",
          "description" : "optional, in cents filter\n\nAmount for this transaction.\n**Supported operators :**\nis, is_not, lt, lte, gt, gte, between\n\n**Example →**\n*amount\\[is\\] = \"1200\"*\n",
          "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\n\nTo filter based on transaction's unused authorized/blocked amount.\n**Supported operators :**\nis, is_not, lt, lte, gt, gte, between\n\n**Example →**\n*amount_capturable\\[gte\\] = \"1200\"*\n",
          "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\n\nThe status of this transaction. Possible values are : in_progress, success, voided, failure, timeout, needs_attention.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*status\\[is_not\\] = \"success\"*\n",
          "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.\n* `success` - The transaction is successful.\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* `timeout` - Transaction failed because of Gateway not accepting the connection.\n* `needs_attention` - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually\n* `late_failure` - This status indicates that late failure has been recorded for the transaction that has encountered success state in the previous stage.\n",
                "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.\n* `success` - The transaction is successful.\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* `timeout` - Transaction failed because of Gateway not accepting the connection.\n* `needs_attention` - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually\n* `late_failure` - This status indicates that late failure has been recorded for the transaction that has encountered success state in the previous stage.\n",
                "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.\n* `success` - The transaction is successful.\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* `timeout` - Transaction failed because of Gateway not accepting the connection.\n* `needs_attention` - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually\n* `late_failure` - This status indicates that late failure has been recorded for the transaction that has encountered success state in the previous stage.\n",
                "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.\n* `success` - The transaction is successful.\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* `timeout` - Transaction failed because of Gateway not accepting the connection.\n* `needs_attention` - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually\n* `late_failure` - This status indicates that late failure has been recorded for the transaction that has encountered success state in the previous stage.\n",
                "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\n\nTo filter based on `updated_at`.\nThis 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`\ninput parameter as `updated_at`\nfor a faster response.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*updated_at\\[before\\] = \"1243545465\"*\n",
          "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\n\nSorts based on the specified attribute.\n**Supported attributes :**\ndate, updated_at\n\n**Supported sort-orders :**\nasc, desc\n\n**Example →**\n*sort_by\\[asc\\] = \"date\"*\n\nThis will sort the result based on the 'date' attribute in ascending(earliest first) order.\n",
          "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\n"
                          }
                        },
                        "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`.\n",
                      "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/v2/pcv-1/transactions/transaction-object#status) that can be updated to either [success](/docs/api/v2/pcv-1/transactions/transaction-object#status) or [failure](/docs/api/v2/pcv-1/transactions/transaction-object#status) status.\n",
        "operationId" : "reconcile_transaction",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "transaction-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/transaction-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "id_at_gateway" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "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/v2/pcv-1/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/v2/pcv-1/transactions/transaction-object#status)\n.\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/v2/pcv-1/invoices/invoice-object#status) status if the [dunning](https://www.chargebee.com/docs/payments/1.0/dunning-v2.html) is configured.\n  * the invoice will be moved to the [not_paid](/docs/api/v2/pcv-1/invoices/invoice-object#status) status if the [dunning](https://www.chargebee.com/docs/payments/1.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/v2/pcv-1/transactions/transaction-object#status)\n  status, - and the invoice is associated with the transaction, the transaction [amount](/docs/api/v2/pcv-1/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/v2/pcv-1/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\n"
                    }
                  },
                  "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.\n",
        "operationId" : "retrieve_a_transaction",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "transaction-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/transaction-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "transaction" : {
                      "$ref" : "#/components/schemas/Transaction",
                      "description" : "Resource object representing transaction\n"
                    }
                  },
                  "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" : "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).\nIf not passed then all of [amount_unused](/docs/api/transactions/transaction-object#amount_unused)\nis refunded.\n",
                    "minimum" : 1,
                    "example" : null
                  },
                  "comment" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Remarks, if any, on the refund.\n",
                    "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\n"
                    }
                  },
                  "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`.\n",
        "operationId" : "record_an_offline_refund",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "transaction-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/transaction-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "amount" : {
                    "type" : "integer",
                    "format" : "int64",
                    "deprecated" : false,
                    "description" : "The amount to be recorded as refunded. Must not exceed [amount_unused](/docs/api/transactions/transaction-object#amount_unused).\nIf not passed then all of [amount_unused](/docs/api/transactions/transaction-object#amount_unused)\nis recorded as refunded.\n",
                    "minimum" : 1,
                    "example" : null
                  },
                  "payment_method" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The payment method used to make the refund.\n\n* check - Check\n* cash - Cash\n* custom - Custom\n* chargeback -\n  Only applicable for a transaction of [type](/docs/api/transactions/transaction-object#type)\n  = `refund`.\n  This value is set by Chargebee when an automated [chargeback](https://www.chargebee.com/docs/chargeback.html#chargeback-process)\n  occurs. You can also set this explicitly when [recording a refund](/docs/api/transactions/record-an-offline-refund)\n  .\n* other - Payment Methods other than the above types\n* bank_transfer - Bank Transfer\n",
                    "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.\n",
                    "example" : null
                  },
                  "reference_number" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The reference number for this transaction. For example, the check number when `payment_method`\n= `check`\n.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "custom_payment_method_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Identifier of the custom payment method of this transaction.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "comment" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Remarks, if any, on the refund.\n",
                    "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\n"
                    }
                  },
                  "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.\n",
        "operationId" : "void_an_authorization_transaction",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "transaction-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/transaction-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "transaction" : {
                      "$ref" : "#/components/schemas/Transaction",
                      "description" : "Resource object representing transaction\n"
                    }
                  },
                  "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/1.0/payment-gateways-and-configuration/stripe#auth-and-capture).  \n* Supported only for Card payments.\n* Currently supported only for **Stripe**.\n",
        "operationId" : "create_an_authorization_payment",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "customer_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Identifier of the customer.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "payment_source_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Payment source to be used for authorizing the transaction.\n",
                    "maxLength" : 40,
                    "example" : null
                  },
                  "currency_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The currency code (ISO 4217 format) of the transaction amount.\n",
                    "maxLength" : 3,
                    "example" : null
                  },
                  "amount" : {
                    "type" : "integer",
                    "format" : "int64",
                    "deprecated" : false,
                    "description" : "The amount to be blocked.\n",
                    "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\n"
                    }
                  },
                  "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.\n",
        "operationId" : "list_payments_for_an_invoice",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "invoice-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/invoice-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        }, {
          "name" : "limit",
          "in" : "query",
          "description" : "The number of resources to be returned.\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`\nto the value of `next_offset`\nobtained in the previous iteration of the API call.\n",
          "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\n"
                          }
                        },
                        "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`.\n",
                      "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.\n",
        "operationId" : "delete_an_offline_transaction",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "transaction-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/transaction-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "comment" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Reason for deleting this transaction. This comment will be added to the associated entity.\n",
                    "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\n"
                    }
                  },
                  "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" : "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" : "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.\n* `funds_withdrawn` - The gateway has withdrawn the disputed amount pending resolution.\n* `in_review` - Evidence has been submitted and the dispute is being reviewed.\n* `cancelled` - The dispute was withdrawn before it was resolved.\n* `lost` - The dispute was resolved in the cardholder's favour.\n* `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.\n* `funds_withdrawn` - The gateway has withdrawn the disputed amount pending resolution.\n* `in_review` - Evidence has been submitted and the dispute is being reviewed.\n* `cancelled` - The dispute was withdrawn before it was resolved.\n* `lost` - The dispute was resolved in the cardholder's favour.\n* `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.\n* `funds_withdrawn` - The gateway has withdrawn the disputed amount pending resolution.\n* `in_review` - Evidence has been submitted and the dispute is being reviewed.\n* `cancelled` - The dispute was withdrawn before it was resolved.\n* `lost` - The dispute was resolved in the cardholder's favour.\n* `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.\n* `funds_withdrawn` - The gateway has withdrawn the disputed amount pending resolution.\n* `in_review` - Evidence has been submitted and the dispute is being reviewed.\n* `cancelled` - The dispute was withdrawn before it was resolved.\n* `lost` - The dispute was resolved in the cardholder's favour.\n* `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.\n* `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.\n* `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.\n* `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.\n* `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).\n",
            "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/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.\n\nUse one of the following methods to open the hosted page:\n\n* **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.\n* **Standalone page** : Redirect the customer to the hosted page `url`.\n\nDo not embed the hosted page in your own [iframe](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/iframe).\n",
        "operationId" : "extend_subscription",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "expiry" : {
                    "type" : "integer",
                    "format" : "int32",
                    "deprecated" : false,
                    "description" : "Expiry (in days) for the link generated. No expiry will be set if this is not specified.\n",
                    "maximum" : 500,
                    "minimum" : 1,
                    "example" : null
                  },
                  "billing_cycle" : {
                    "type" : "integer",
                    "format" : "int32",
                    "deprecated" : false,
                    "description" : "Number of billing cycles to extend. If not specified, plan's billing cycle will be used.\n",
                    "minimum" : 1,
                    "example" : null
                  },
                  "subscription" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for subscription\n",
                    "properties" : {
                      "id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "A unique and immutable identifier for the subscription. If not provided, it is autogenerated.\n",
                        "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\n"
                    }
                  },
                  "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.\n",
        "operationId" : "notify_an_event",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "event_name" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The event that need to passed to a different system.\n\n* cancellation_page_loaded - Indicates native cancellation flow provided by the merchant is loaded rather than the retention flow.\n",
                    "enum" : [ "cancellation_page_loaded" ],
                    "example" : null
                  },
                  "occurred_at" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "Timestamp indicating when this event had occurred.\n.\n",
                    "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.\n\n* `subscription_id`: A unique and immutable identifier for the subscription. .\n",
                    "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\n",
                      "example" : null
                    }
                  },
                  "required" : [ "success" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/hosted_pages" : {
      "get" : {
        "tags" : [ "hosted_pages" ],
        "summary" : "List hosted pages",
        "description" : "This API retrieves the list of hosted page resources.\n",
        "operationId" : "list_hosted_pages",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "limit",
          "in" : "query",
          "description" : "The number of resources to be returned.\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`\nto the value of `next_offset`\nobtained in the previous iteration of the API call.\n",
          "required" : false,
          "deprecated" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "maxLength" : 1000,
            "example" : null
          }
        }, {
          "name" : "id",
          "in" : "query",
          "description" : "optional, string filter\n\nUnique identifier generated for each hosted page requested.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*id\\[is\\] = \"Edi69nxpu6BeGBd9Fjcd0tqCSwb0sRcuKa\"*\n",
          "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\n\nType of the requested hosted page. Possible values are : checkout_new, checkout_existing, update_payment_method, manage_payment_sources, collect_now, extend_subscription, checkout_gift, claim_gift, checkout_one_time, pre_cancel.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*type\\[is_not\\] = \"checkout_new\"*\n",
          "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\n* `checkout_existing` - Checkout existing Subscription\n* `update_card` - **(Deprecated)** Update Card for a Customer\n* `update_payment_method` - **(Deprecated)** Update Payment Method for a Customer\n* `manage_payment_sources` - Manage Payments for a customer\n* `collect_now` - Collect Unpaid Invoices for a Customer\n* `extend_subscription` - To extend a Subscription period\n* `checkout_gift` - Checkout a gift subscription\n* `claim_gift` - Claim a gift subscription\n* `checkout_one_time` - Checkout one time\n* `pre_cancel` - This hosted page is used to help retain customers when they attempt to cancel their account or subscription.\n* `view_voucher` - View Details of a voucher\n* `accept_quote` - Accept Quote",
                "enum" : [ "checkout_new", "checkout_existing", "manage_payment_sources", "collect_now", "extend_subscription", "checkout_gift", "claim_gift", "checkout_one_time", "pre_cancel", "view_voucher", "accept_quote" ],
                "example" : null
              },
              "is_not" : {
                "type" : "string",
                "description" : "* `checkout_new` - Checkout new Subscription\n* `checkout_existing` - Checkout existing Subscription\n* `update_card` - **(Deprecated)** Update Card for a Customer\n* `update_payment_method` - **(Deprecated)** Update Payment Method for a Customer\n* `manage_payment_sources` - Manage Payments for a customer\n* `collect_now` - Collect Unpaid Invoices for a Customer\n* `extend_subscription` - To extend a Subscription period\n* `checkout_gift` - Checkout a gift subscription\n* `claim_gift` - Claim a gift subscription\n* `checkout_one_time` - Checkout one time\n* `pre_cancel` - This hosted page is used to help retain customers when they attempt to cancel their account or subscription.\n* `view_voucher` - View Details of a voucher\n* `accept_quote` - Accept Quote",
                "enum" : [ "checkout_new", "checkout_existing", "manage_payment_sources", "collect_now", "extend_subscription", "checkout_gift", "claim_gift", "checkout_one_time", "pre_cancel", "view_voucher", "accept_quote" ],
                "example" : null
              },
              "in" : {
                "type" : "string",
                "description" : "* `checkout_new` - Checkout new Subscription\n* `checkout_existing` - Checkout existing Subscription\n* `update_card` - **(Deprecated)** Update Card for a Customer\n* `update_payment_method` - **(Deprecated)** Update Payment Method for a Customer\n* `manage_payment_sources` - Manage Payments for a customer\n* `collect_now` - Collect Unpaid Invoices for a Customer\n* `extend_subscription` - To extend a Subscription period\n* `checkout_gift` - Checkout a gift subscription\n* `claim_gift` - Claim a gift subscription\n* `checkout_one_time` - Checkout one time\n* `pre_cancel` - This hosted page is used to help retain customers when they attempt to cancel their account or subscription.\n* `view_voucher` - View Details of a voucher\n* `accept_quote` - Accept Quote",
                "enum" : [ "checkout_new", "checkout_existing", "manage_payment_sources", "collect_now", "extend_subscription", "checkout_gift", "claim_gift", "checkout_one_time", "pre_cancel", "view_voucher", "accept_quote" ],
                "pattern" : "^\\[(checkout_new|checkout_existing|update_card|update_payment_method|manage_payment_sources|collect_now|extend_subscription|checkout_gift|claim_gift|checkout_one_time|pre_cancel|view_voucher|accept_quote)(,(checkout_new|checkout_existing|update_card|update_payment_method|manage_payment_sources|collect_now|extend_subscription|checkout_gift|claim_gift|checkout_one_time|pre_cancel|view_voucher|accept_quote))*\\]$",
                "example" : null
              },
              "not_in" : {
                "type" : "string",
                "description" : "* `checkout_new` - Checkout new Subscription\n* `checkout_existing` - Checkout existing Subscription\n* `update_card` - **(Deprecated)** Update Card for a Customer\n* `update_payment_method` - **(Deprecated)** Update Payment Method for a Customer\n* `manage_payment_sources` - Manage Payments for a customer\n* `collect_now` - Collect Unpaid Invoices for a Customer\n* `extend_subscription` - To extend a Subscription period\n* `checkout_gift` - Checkout a gift subscription\n* `claim_gift` - Claim a gift subscription\n* `checkout_one_time` - Checkout one time\n* `pre_cancel` - This hosted page is used to help retain customers when they attempt to cancel their account or subscription.\n* `view_voucher` - View Details of a voucher\n* `accept_quote` - Accept Quote",
                "enum" : [ "checkout_new", "checkout_existing", "manage_payment_sources", "collect_now", "extend_subscription", "checkout_gift", "claim_gift", "checkout_one_time", "pre_cancel", "view_voucher", "accept_quote" ],
                "pattern" : "^\\[(checkout_new|checkout_existing|update_card|update_payment_method|manage_payment_sources|collect_now|extend_subscription|checkout_gift|claim_gift|checkout_one_time|pre_cancel|view_voucher|accept_quote)(,(checkout_new|checkout_existing|update_card|update_payment_method|manage_payment_sources|collect_now|extend_subscription|checkout_gift|claim_gift|checkout_one_time|pre_cancel|view_voucher|accept_quote))*\\]$",
                "example" : null
              }
            }
          }
        }, {
          "name" : "state",
          "in" : "query",
          "description" : "optional, enumerated string filter\n\nIndicating the current state of the hosted page resource. Possible values are : created, requested, succeeded, cancelled, acknowledged.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*state\\[is_not\\] = \"succeeded\"*\n",
          "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.\n* `requested` - Indicates the hosted page is requested by the website\n* `succeeded` - Indicates the hosted page is successfully submitted by the user and response is sent to the return url.\n* `cancelled` - Indicates the page is cancelled by the end user after requesting it.\n* `failed` - **(Deprecated)** Indicates the page submition is failed and response is sent to the return url.\n* `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.\n* `requested` - Indicates the hosted page is requested by the website\n* `succeeded` - Indicates the hosted page is successfully submitted by the user and response is sent to the return url.\n* `cancelled` - Indicates the page is cancelled by the end user after requesting it.\n* `failed` - **(Deprecated)** Indicates the page submition is failed and response is sent to the return url.\n* `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.\n* `requested` - Indicates the hosted page is requested by the website\n* `succeeded` - Indicates the hosted page is successfully submitted by the user and response is sent to the return url.\n* `cancelled` - Indicates the page is cancelled by the end user after requesting it.\n* `failed` - **(Deprecated)** Indicates the page submition is failed and response is sent to the return url.\n* `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.\n* `requested` - Indicates the hosted page is requested by the website\n* `succeeded` - Indicates the hosted page is successfully submitted by the user and response is sent to the return url.\n* `cancelled` - Indicates the page is cancelled by the end user after requesting it.\n* `failed` - **(Deprecated)** Indicates the page submition is failed and response is sent to the return url.\n* `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\n\nTimestamp indicating when this hosted page was last updated.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*updated_at\\[on\\] = \"1490784813\"*\n",
          "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`.\n",
                      "maxLength" : 1000,
                      "example" : null
                    }
                  },
                  "required" : [ "list" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/hosted_pages/checkout_one_time" : {
      "post" : {
        "tags" : [ "hosted_pages" ],
        "summary" : "Checkout one-time payments",
        "description" : "Create a Chargebee hosted page to accept payment from a customer and checkout [non-recurring addons](/docs/api/v2/pcv-1/addons/addon-object#charge_type) and [one-time charges](/docs/api/v2/pcv-1/invoices/create-invoice-for-a-one-time-charge).\n\nThe following steps describe how best to use this API:\n\n1. Call this endpoint, providing [non-recurring addons](/docs/api/v2/pcv-1/addons/addon-object#charge_type), [one-time charges](/docs/api/v2/pcv-1/invoices/create-invoice-for-a-one-time-charge), [coupons](/docs/api/v2/pcv-1/coupons) and a host of other details such as billing and shipping addresses of the customer, to be prefilled on the checkout page.\n2. Send the customer to the Checkout `url` received in the response.\n3. Once they complete checkout, the non-recurring addons 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.\n4. [Retrieve the hosted page](/docs/api/v2/pcv-1/hosted_pages/retrieve-a-hosted-page) at this stage to get the invoice details.\n",
        "operationId" : "checkout_one-time_payments",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "currency_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The currency code (ISO 4217 format) of the invoice amount.\n",
                    "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)\nfor the invoice are displayed on the PDF invoice sent to the customer.\n",
                    "maxLength" : 2000,
                    "example" : null
                  },
                  "coupon_ids" : {
                    "type" : "array",
                    "deprecated" : false,
                    "description" : "Identifier of the coupon as a List. Coupon Codes can also be passed.\n",
                    "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.\n\n**Note** :\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 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.\n* Redirect URL configured in Settings \\> Hosted Pages Settings would be overriden by this redirect URL.\n* *Eg :* *http://yoursite.com?id=\\*\\*\\&state=succeeded*\n* This parameter is not applicable for iframe messaging.\n",
                    "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.\n\n**Note**\n: - Cancel URL configured in Settings \\> Hosted Pages Settings would be overriden by this cancel URL.\n\n*Eg : http://yoursite.com?id=\\&state=cancelled*\n\n* This parameter is not applicable for iframe messaging and [in-app](https://www.chargebee.com/docs/2.0/checkout.html) checkout.\n",
                    "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.\nFor 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/v2/pcv-1/hosted_pages/checkout-one-time-payments)'s query parameters. Using this ID, you can fetch the hosted page and perform actions related to the success of the marketing campaign.\n",
                    "maxLength" : 2048,
                    "example" : null
                  },
                  "embed" : {
                    "type" : "boolean",
                    "default" : true,
                    "deprecated" : false,
                    "description" : "If true then hosted page formatted to be shown in iframe. If false, it is formatted to be shown as a separate page.\n\n**Note**\n: For [in-app](https://www.chargebee.com/docs/checkout-v3.html)\ncheckout, default is false.\n",
                    "example" : null
                  },
                  "iframe_messaging" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "If true then iframe will communicate with the parent window. Applicable only for embedded(iframe) hosted pages. If you're using iframe_messaging you need to implement onSuccess \\& onCancel callbacks.\n\n**Note**\n: This parameter is not applicable for [in-app](https://www.chargebee.com/docs/checkout-v3.html)\ncheckout.\n",
                    "example" : null
                  },
                  "customer" : {
                    "type" : "object",
                    "additionalProperties" : true,
                    "deprecated" : false,
                    "description" : "Parameters for customer\n",
                    "properties" : {
                      "id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The unique ID of the customer for which this `hosted_page`\nshould be created. When not provided, a new customer is created with the ID set to the value provided for `subscription[id]`.\nIf `subscription[id]`\nis unavailable, then the customer ID is autogenerated.\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.\n",
                        "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\n",
                        "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\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "company" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Company name of the customer.\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Phone number of the customer\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.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "taxability" : {
                        "type" : "string",
                        "default" : "taxable",
                        "deprecated" : false,
                        "description" : "Specifies if the customer is liable for tax\n\n* exempt -\n  * 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.\n  * 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.\n* taxable -\n  Computes tax for the customer based on the [site configuration](https://www.chargebee.com/docs/tax.html).\n  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.\n",
                        "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)\n\n`country`\nas\n`XI`\n(which is **United Kingdom - Northern Ireland**\n), the first two characters of the [full VAT number](https://en.wikipedia.org/wiki/VAT_identification_number)\ncan be overridden by setting\n[vat_number_prefix](/docs/api/customers/customer-object#vat_number_prefix)\n.\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).\nOnly applicable specifically for customers with [billing_address](/docs/api/customers/customer-object#billing_address)\n\n`country`\nas `XI`\n(which is **United Kingdom - Northern Ireland**\n).\n\nWhen you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\nin 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\nthe Brexit configuration, you have the option of setting [billing_address](/docs/api/customers/customer-object#billing_address)\n\n`country`\nas `XI`.\nThat's the code for **United Kingdom - Northern Ireland** .\nThe first two characters of the VAT number in such a case is\n`XI`\nby default. However, if the VAT number was registered in UK, the value should be `GB`.\nSet\n`vat_number_prefix`\nto `GB`\nfor such cases.\n",
                        "maxLength" : 10,
                        "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\n",
                    "properties" : {
                      "po_number" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Purchase Order Number for this invoice.\n",
                        "maxLength" : 100,
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "card" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for card\n",
                    "properties" : {
                      "gateway_account_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The gateway account in which this payment source is stored.\n",
                        "maxLength" : 50,
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "billing_address" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for billing_address\n",
                    "properties" : {
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The first name of the billing contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The last name of the billing contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "The email address.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "company" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The company name.\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The phone number.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line3" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 3\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "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`\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.\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://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.\n\n* valid - Address was validated successfully.\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n",
                        "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "shipping_address" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for shipping_address\n",
                    "properties" : {
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The first name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The last name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "The email address.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "company" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The company name.\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The phone number.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line3" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 3\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "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`\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.\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://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.\n\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n* valid - Address was validated successfully.\n",
                        "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "Unique ID of the [addon](/docs/api/v2/pcv-1/addons/addon-object) to be added to the invoice.  \n**Constraints**\n\nThe addon must have [`charge_type`](/docs/api/v2/pcv-1/addons#charge_type) set to `charge`.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "default" : 1,
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price" : {
                        "type" : "array",
                        "description" : "The price or per-unit price of the non-recurring addon. By default, the [value set](/docs/api/v2/pcv-1/addons/addon-object#price) for the addon is used. The value depends on the [type of currency](/docs/api/v2/pcv-1/currencies#currency-values).\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_in_decimal" : {
                        "type" : "array",
                        "description" : "The decimal representation of the quantity of the [non-recurring addon](https://www.chargebee.com/docs/charges.html#non-recurring-addon ).\nProvide the value in major units of the currency. Must be provided when the addon is quantity-based. This parameter can only be passed when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 33,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price_in_decimal" : {
                        "type" : "array",
                        "description" : "When [price overriding](http://chargebee.com/docs/price-override.html )\nis enabled for the site, the price or per-unit price of the [non-recurring addon](https://www.chargebee.com/docs/charges.html#non-recurring-addon )\ncan be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)\nis used by default. Provide the value as a decimal string in major units of the currency. This parameter can only be passed when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      },
                      "date_from" : {
                        "type" : "array",
                        "description" : "The time when the service period for the addon starts.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "unix-time",
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      },
                      "date_to" : {
                        "type" : "array",
                        "description" : "The time when the service period for the addon ends.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "unix-time",
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "charges" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for charges\n",
                    "properties" : {
                      "amount" : {
                        "type" : "array",
                        "description" : "The amount to be charged. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                        "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 ).\nProvide the value in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      },
                      "description" : {
                        "type" : "array",
                        "description" : "Description for this charge\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 250,
                          "example" : null
                        },
                        "example" : null
                      },
                      "taxable" : {
                        "type" : "array",
                        "description" : "The amount to be charged is taxable or not.\n",
                        "items" : {
                          "type" : "boolean",
                          "default" : true,
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax_profile_id" : {
                        "type" : "array",
                        "description" : "Tax profile of the charge.\n",
                        "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)\n.\n",
                        "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)\nto which the item is mapped for calculating the customer's tax in India. Applicable only when both of the following conditions are true:\n\n* [**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.)\n* The [**AvaTax for Sales** integration](https://www.chargebee.com/docs/avalara.html) has been enabled in Chargebee.\n",
                        "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)\n.\n",
                        "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)\nintegration.\n\n* consumed - Transaction is for an item that is consumed directly\n* vendor_use - Transaction is for an item that is subject to vendor use tax\n* wholesale - Transaction is a sale to another company that will resell your product or service to another consumer\n* retail - Transaction is a sale to an end user\n",
                          "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)\nintegration.\n",
                        "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)\nintegration.\n",
                        "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.\n",
                        "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.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "unix-time",
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  }
                },
                "example" : null
              },
              "encoding" : {
                "addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "billing_address" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "card" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "charges" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "customer" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "invoice" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "shipping_address" : {
                  "style" : "deepObject",
                  "explode" : true
                }
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "hosted_page" : {
                      "$ref" : "#/components/schemas/HostedPage",
                      "description" : "Resource object representing hosted_page\n"
                    }
                  },
                  "required" : [ "hosted_page" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/hosted_pages/view_voucher" : {
      "post" : {
        "tags" : [ "hosted_pages" ],
        "summary" : "Create a hosted page to view Boleto vouchers",
        "description" : "Creates a `hosted_page`\nresource of type, `view_voucher`\n. 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.\n",
        "operationId" : "create_a_hosted_page_to_view_boleto_vouchers",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "payment_voucher" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for payment_voucher\n",
                    "properties" : {
                      "id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The unique [ID of the voucher](/docs/api/payment_vouchers/payment_voucher-object#id)\nwhich the customer wants to view.\n",
                        "maxLength" : 40,
                        "example" : null
                      }
                    },
                    "required" : [ "id" ],
                    "example" : null
                  },
                  "customer" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for customer\n",
                    "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.\n",
                        "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\n"
                    }
                  },
                  "required" : [ "hosted_page" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/hosted_pages/checkout_new" : {
      "post" : {
        "tags" : [ "hosted_pages" ],
        "summary" : "Checkout new subscription",
        "description" : "Hosted page to accept card details from the subscriber and create a new subscription. This is similar to our server to server API [Create a Subscription](/docs/api/v2/pcv-1/subscriptions/create-a-subscription).\n\nWhen the redirect URL is notified of the result, we would advise you to [retrieve the subscription](/docs/api/subscriptions/retrieve-a-subscription) and verify the details.\n\n#### Related Tutorials\n\n* [Create a subscription using Chargebee's hosted page](https://www.chargebee.com/tutorials/chargebee-js-checkout-new-subscription/)\n\nAs mentioned before this behavior is very similar to the create subscription API call. All the web hook events will be fired only after the submission of payment details by the customer and successful creation of subscription.\nAny errors related to the payment form that is submitted is handled as a response within the form so that the user is kept informed about the reason for failure to take corrective action.\n",
        "operationId" : "checkout_new_subscription",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "billing_cycles" : {
                    "type" : "integer",
                    "format" : "int32",
                    "deprecated" : false,
                    "description" : "Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.\n",
                    "minimum" : 0,
                    "example" : null
                  },
                  "mandatory_addons_to_remove" : {
                    "type" : "array",
                    "deprecated" : false,
                    "description" : "List of addons IDs that are mandatory to the plan and has to be removed from the subscription.\n",
                    "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)\n.\n",
                    "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)\nfor Calendar Billing. Only applicable when using Calendar Billing. The default value is that which has been configured for the site.\n\n* immediate - Subscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..\n* delayed - Subscription period will be aligned with the configured billing date at the next renewal.\n",
                    "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.\n",
                    "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.\n\n**Note** :\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 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.\n* Redirect URL configured in Settings \\> Hosted Pages Settings would be overriden by this redirect URL.\n* *Eg :* *http://yoursite.com?id=\\*\\*\\&state=succeeded*\n* This parameter is not applicable for iframe messaging.\n",
                    "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.\n\n**Note**\n: - Cancel URL configured in Settings \\> Hosted Pages Settings would be overriden by this cancel URL.\n\n*Eg : http://yoursite.com?id=\\&state=cancelled*\n\n* This parameter is not applicable for iframe messaging and [in-app](https://www.chargebee.com/docs/2.0/checkout.html) checkout.\n",
                    "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.\nFor 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/v2/pcv-1/hosted_pages/checkout-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.\n",
                    "maxLength" : 2048,
                    "example" : null
                  },
                  "embed" : {
                    "type" : "boolean",
                    "default" : true,
                    "deprecated" : false,
                    "description" : "If true then hosted page formatted to be shown in iframe. If false, it is formatted to be shown as a separate page.\n\n**Note**\n: For [in-app](https://www.chargebee.com/docs/checkout-v3.html)\ncheckout, default is false.\n",
                    "example" : null
                  },
                  "iframe_messaging" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "If true then iframe will communicate with the parent window. Applicable only for embedded(iframe) hosted pages. If you're using iframe_messaging you need to implement onSuccess \\& onCancel callbacks.\n\n**Note**\n: This parameter is not applicable for [in-app](https://www.chargebee.com/docs/checkout-v3.html)\ncheckout.\n",
                    "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.\n",
                    "example" : null
                  },
                  "subscription" : {
                    "type" : "object",
                    "additionalProperties" : true,
                    "deprecated" : false,
                    "description" : "Parameters for subscription\n",
                    "properties" : {
                      "id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "A unique and immutable identifier for the subscription. If not provided, it is autogenerated.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "plan_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Identifier of the plan for this subscription\n",
                        "maxLength" : 100,
                        "example" : null
                      },
                      "plan_quantity" : {
                        "type" : "integer",
                        "format" : "int32",
                        "default" : 1,
                        "deprecated" : false,
                        "description" : "Plan quantity for this subscription\n",
                        "minimum" : 1,
                        "example" : null
                      },
                      "plan_quantity_in_decimal" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "maxLength" : 33,
                        "example" : null
                      },
                      "plan_unit_price" : {
                        "type" : "integer",
                        "format" : "int64",
                        "deprecated" : false,
                        "description" : "Amount that will override the Plan's default price. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                        "minimum" : 0,
                        "example" : null
                      },
                      "plan_unit_price_in_decimal" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "When [price overriding](http://chargebee.com/docs/price-override.html )\nis enabled for the site, the price or per-unit price of the plan can be set here. The value [set for the plan](/docs/api/v2/pcv-1/plans/plan-object#price)\nis used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "maxLength" : 39,
                        "example" : null
                      },
                      "setup_fee" : {
                        "type" : "integer",
                        "format" : "int64",
                        "deprecated" : false,
                        "description" : "Amount that will override the default setup fee. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                        "minimum" : 0,
                        "example" : null
                      },
                      "trial_end" : {
                        "type" : "integer",
                        "format" : "unix-time",
                        "deprecated" : false,
                        "description" : "The time at which the trial ends for this subscription. Can be specified to override the default trial period.If **'0'**\nis passed, the subscription will be activated immediately. This parameter overrides the Plan's [`trial_period`](/docs/api/v2/pcv-1/plans)\ndirectly.\n",
                        "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:\n\n* Backdating is enabled for subscription creation operations.\n* 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.\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, `start_date` cannot be earlier than 14th February.\n",
                        "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.\n\n* off - Automatic collection of charges will not be made for this subscription. Use this for offline payments.\n* on - Whenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.\n",
                        "enum" : [ "on", "off" ],
                        "example" : null
                      },
                      "offline_payment_method" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The preferred offline payment method for the subscription.\n\n* uk_automated_bank_transfer - UK Automated Bank Transfer\n* jp_automated_bank_transfer - JP Automated Bank Transfer\n* bank_transfer - Bank Transfer\n* us_automated_bank_transfer - US Automated Bank Transfer\n* boleto - Boleto\n* no_preference - No Preference\n* sepa_credit - SEPA Credit\n* mx_automated_bank_transfer - MX Automated Bank Transfer\n* ach_credit - ACH Credit\n* custom - Custom\n* eu_automated_bank_transfer - EU Automated Bank Transfer\n* cash - Cash\n* check - Check\n",
                        "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)\ndisplayed on the invoice PDF.\n",
                        "maxLength" : 2000,
                        "example" : null
                      },
                      "affiliate_token" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "A unique tracking token\n",
                        "maxLength" : 250,
                        "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`\nor a custom value depending on the [site configuration](https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms)\n.\n",
                        "maximum" : 100,
                        "minimum" : 1,
                        "example" : null
                      }
                    },
                    "required" : [ "plan_id" ],
                    "example" : null
                  },
                  "customer" : {
                    "type" : "object",
                    "additionalProperties" : true,
                    "deprecated" : false,
                    "description" : "Parameters for customer\n",
                    "properties" : {
                      "id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The unique ID of the customer for which this `hosted_page` should be created.\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.\n",
                        "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\n",
                        "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\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "company" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Company name of the customer.\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Phone number of the customer\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.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "taxability" : {
                        "type" : "string",
                        "default" : "taxable",
                        "deprecated" : false,
                        "description" : "Specifies if the customer is liable for tax\n\n* exempt -\n  * 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.\n  * 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.\n* taxable -\n  Computes tax for the customer based on the [site configuration](https://www.chargebee.com/docs/tax.html).\n  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.\n",
                        "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)\n\n`country`\nas\n`XI`\n(which is **United Kingdom - Northern Ireland**\n), the first two characters of the [full VAT number](https://en.wikipedia.org/wiki/VAT_identification_number)\ncan be overridden by setting\n[vat_number_prefix](/docs/api/customers/customer-object#vat_number_prefix)\n.\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).\nOnly applicable specifically for customers with [billing_address](/docs/api/customers/customer-object#billing_address)\n\n`country`\nas `XI`\n(which is **United Kingdom - Northern Ireland**\n).\n\nWhen you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\nin 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\nthe Brexit configuration, you have the option of setting [billing_address](/docs/api/customers/customer-object#billing_address)\n\n`country`\nas `XI`.\nThat's the code for **United Kingdom - Northern Ireland** .\nThe first two characters of the VAT number in such a case is\n`XI`\nby default. However, if the VAT number was registered in UK, the value should be `GB`.\nSet\n`vat_number_prefix`\nto `GB`\nfor such cases.\n",
                        "maxLength" : 10,
                        "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
                  },
                  "card" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for card\n",
                    "properties" : {
                      "gateway_account_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The gateway account in which this payment source is stored.\n",
                        "maxLength" : 50,
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "billing_address" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for billing_address\n",
                    "properties" : {
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The first name of the billing contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The last name of the billing contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "The email address.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "company" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The company name.\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The phone number.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line3" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 3\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "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`\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.\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://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.\n\n* valid - Address was validated successfully.\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n",
                        "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "shipping_address" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for shipping_address\n",
                    "properties" : {
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The first name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The last name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "The email address.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "company" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The company name.\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The phone number.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line3" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 3\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "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`\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.\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://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.\n\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n* valid - Address was validated successfully.\n",
                        "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "contract_term" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for contract_term\n",
                    "properties" : {
                      "action_at_term_end" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Action to be taken when the contract term completes.\n\n* evergreen - Contract term completes and the subscription renews.\n* renew -\n  * 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).\n  * 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`](/docs/api/contract_terms/contract_term-object#contract_end)\n, 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.\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "Identifier of the addon. Multiple addons can be passed.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "default" : 1,
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_in_decimal" : {
                        "type" : "array",
                        "description" : "The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis 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 addon. The value depends on the [type of currency](/docs/api/getting-started).  \n**Note:**\n\nFor recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the [addon period](/docs/api/v2/pcv-1/addons/addon-object#period). For example, consider the following details:\n\n* The `unit_price` provided is $10\n* The addon billing period is 1 month.\n* The plan billing period is 3 months.\n* The addon is only billed for $10 on each subscription renewal.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price_in_decimal" : {
                        "type" : "array",
                        "description" : "When [price overriding](http://chargebee.com/docs/price-override.html )\nis enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)\nis used by default. However, the price provided here is considered as the price of the addon for an entire billing cycle of the subscription regardless of the value of the addon `period`.\nProvide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      },
                      "billing_cycles" : {
                        "type" : "array",
                        "description" : "Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "event_based_addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for event_based_addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "A unique 'id' used to identify the addon.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price" : {
                        "type" : "array",
                        "description" : "Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_in_decimal" : {
                        "type" : "array",
                        "description" : "The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 33,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price_in_decimal" : {
                        "type" : "array",
                        "description" : "When [price overriding](http://chargebee.com/docs/price-override.html )\nis enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)\nis used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      },
                      "service_period_in_days" : {
                        "type" : "array",
                        "description" : "Defines service period of the addon in days from the day of charge.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "maximum" : 4000,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "on_event" : {
                        "type" : "array",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "description" : "Event on which this addon will be charged.\n\n* plan_activation - Addon will be charged on plan activation.\n* contract_termination - Addon will be charged on contract termination.\n* subscription_activation - Addon will be charged on subscription activation.\n* subscription_creation - Addon will be charged on subscription creation.\n* subscription_trial_start - Addon will be charged when the trial period starts.\n",
                          "enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ],
                          "example" : null
                        },
                        "example" : null
                      },
                      "charge_once" : {
                        "type" : "array",
                        "description" : "If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.\n",
                        "items" : {
                          "type" : "boolean",
                          "default" : true,
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      },
                      "charge_on" : {
                        "type" : "array",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "description" : "Indicates when the non-recurring addon will be charged.\n\n* immediately - Charges for the addon will be applied immediately.\n* on_event - Charge for the addon will be applied on the occurrence of a specified event.\n",
                          "enum" : [ "immediately", "on_event" ],
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  }
                },
                "example" : null
              },
              "encoding" : {
                "addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "billing_address" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "card" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "contract_term" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "customer" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "event_based_addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "shipping_address" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "subscription" : {
                  "style" : "deepObject",
                  "explode" : true
                }
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "hosted_page" : {
                      "$ref" : "#/components/schemas/HostedPage",
                      "description" : "Resource object representing hosted_page\n"
                    }
                  },
                  "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
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "redirect_url" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Used to specify the destination URL to which a user is redirected after invoices are paid. The [transaction ID](/docs/api/transactions/transaction-object#id)\nof the transactions made through the Pay Now hosted page will be sent as return variables along with the URL.\n",
                    "maxLength" : 250,
                    "example" : null
                  },
                  "currency_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The currency code (ISO 4217 format) of the specified *credit amount*\n.\n",
                    "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.\n\n* ask - Let the customer choose whether to save the payment method.\n* never - Do not save the payment method.\n* always - Automatically save the payment method to the customer's account for future use.\n",
                    "enum" : [ "always", "ask", "never" ],
                    "example" : null
                  },
                  "customer" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for customer\n",
                    "properties" : {
                      "id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Identifier of the customer.\n",
                        "maxLength" : 50,
                        "example" : null
                      }
                    },
                    "required" : [ "id" ],
                    "example" : null
                  },
                  "card" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for card\n",
                    "properties" : {
                      "gateway_account_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The gateway account in which this payment source is stored.\n",
                        "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\n"
                    }
                  },
                  "required" : [ "hosted_page" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/hosted_pages/checkout_gift" : {
      "post" : {
        "tags" : [ "hosted_pages" ],
        "summary" : "Checkout gift subscription",
        "description" : "Creates a hosted page for a customer (called the gifter) to gift a subscription to another customer (called the receiver).\n\n#### Gifter customer resource lookup and creation\n\nWhen [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.\n\n#### Gift receiver customer resource lookup and creation\n\nOnce 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.\n",
        "operationId" : "checkout_gift_subscription",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "redirect_url" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "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.\n\n**Note** :\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 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.\n* Redirect URL configured in Settings \\> Hosted Pages Settings would be overriden by this redirect URL.\n* *Eg :* *http://yoursite.com?id=\\*\\*\\&state=succeeded*\n* This parameter is not applicable for iframe messaging.\n",
                    "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)\n.\n",
                    "items" : {
                      "type" : "string",
                      "deprecated" : false,
                      "maxLength" : 100,
                      "example" : null
                    },
                    "example" : null
                  },
                  "gifter" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for gifter\n",
                    "properties" : {
                      "customer_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Gifter customer id\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.\n",
                        "maxLength" : 50,
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "subscription" : {
                    "type" : "object",
                    "additionalProperties" : true,
                    "deprecated" : false,
                    "description" : "Parameters for subscription\n",
                    "properties" : {
                      "plan_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Identifier of the plan for this subscription\n",
                        "maxLength" : 100,
                        "example" : null
                      },
                      "plan_quantity" : {
                        "type" : "integer",
                        "format" : "int32",
                        "default" : 1,
                        "deprecated" : false,
                        "description" : "Plan quantity for this subscription\n",
                        "minimum" : 1,
                        "example" : null
                      },
                      "plan_quantity_in_decimal" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Plan Quantity for this subscription in Multi Decimal\n",
                        "maxLength" : 33,
                        "example" : null
                      }
                    },
                    "required" : [ "plan_id" ],
                    "example" : null
                  },
                  "addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "Identifier of the addon. Multiple addons can be passed.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "default" : 1,
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_in_decimal" : {
                        "type" : "array",
                        "description" : "The decimal representation of the quantity of the addon. Returned for quantity-based plans when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 33,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  }
                },
                "example" : null
              },
              "encoding" : {
                "addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "gifter" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "subscription" : {
                  "style" : "deepObject",
                  "explode" : true
                }
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "hosted_page" : {
                      "$ref" : "#/components/schemas/HostedPage",
                      "description" : "Resource object representing hosted_page\n"
                    }
                  },
                  "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* Hosted page URL to accept a quote cannot be generated for one-time charges.\n* Customers with existing subscriptions can generate a quote for new subscriptions. However, Hosted page URL to accept a quote cannot be generated for new subscriptions in V1 and V2 hosted pages.\n",
        "operationId" : "accept_a_quote",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "redirect_url" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "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.\n\n**Note** :\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 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.\n* Redirect URL configured in Settings \\> Hosted Pages Settings would be overriden by this redirect URL.\n* *Eg :* *http://yoursite.com?id=\\*\\*\\&state=succeeded*\n* This parameter is not applicable for iframe messaging.\n",
                    "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.\n\n* full_page - Renders the hosted page in a full-page layout.\n* in_app - Renders the hosted page in an in-app layout.\n",
                    "enum" : [ "in_app", "full_page" ],
                    "example" : null
                  },
                  "quote" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for quote\n",
                    "properties" : {
                      "id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The quote number. Acts as a identifier for quote and typically generated sequentially.\n",
                        "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\n"
                    }
                  },
                  "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.\n",
        "operationId" : "claim_a_gift_subscription",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "redirect_url" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "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.\n\n**Note** :\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 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.\n* Redirect URL configured in Settings \\> Hosted Pages Settings would be overriden by this redirect URL.\n* *Eg :* *http://yoursite.com?id=\\*\\*\\&state=succeeded*\n* This parameter is not applicable for iframe messaging.\n",
                    "maxLength" : 250,
                    "example" : null
                  },
                  "gift" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for gift\n",
                    "properties" : {
                      "id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Uniquely identifies a gift\n",
                        "maxLength" : 150,
                        "example" : null
                      }
                    },
                    "required" : [ "id" ],
                    "example" : null
                  },
                  "customer" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for customer\n",
                    "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.\n",
                        "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\n"
                    }
                  },
                  "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`\nresource of `type`\n`pre_cancel`\n. Route canceling users to this page to provide them a retention experience and start saving revenue.\nThe 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)\n, along with the data provided as input to this endpoint. Call the endpoint before your customer clicks the **Cancel**\nbutton, and when they do, route them to the [url](/docs/api/hosted_pages/hosted_page-object#url)\nin the endpoint response.\n",
        "operationId" : "create_a_pre-cancel_hosted_page",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "pass_thru_content" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "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.\n\nAlthough 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`.\n.\n",
                    "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.\n",
                    "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**\nto cancel the subscription.\n",
                    "maxLength" : 250,
                    "example" : null
                  },
                  "locale" : {
                    "type" : "string",
                    "deprecated" : false,
                    "maxLength" : 50,
                    "example" : null
                  },
                  "subscription" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for subscription\n",
                    "properties" : {
                      "id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The unique ID of the subscription which the customer wants to cancel.\n",
                        "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\n"
                    }
                  },
                  "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)\nis automatically changed to `succeeded`\n. 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`\nstate and change its state to `acknowledged`\n.\n\n**Note:**\nThe hosted page status must be succeeded for this API call to be allowed.\n",
        "operationId" : "acknowledge_a_hosted_page",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "hosted-page-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/hosted-page-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "hosted_page" : {
                      "$ref" : "#/components/schemas/HostedPage",
                      "description" : "Resource object representing hosted_page\n"
                    }
                  },
                  "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.\n\nThis 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.\n\nCustomer 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.\n",
        "operationId" : "retrieve_direct_debit_agreement_pdf",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "payment_source_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Payment source to be used for this payment.\n",
                    "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\n"
                    }
                  },
                  "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" : "Retrieves a hosted page resource.\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" : "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\n"
                    }
                  },
                  "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.\n\nUse one of the following methods to open the hosted page:\n\n* **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.\n* **Standalone page** : Redirect the customer to the hosted page `url`.\n\nDo not embed the hosted page in your own [iframe](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/iframe).\n",
        "operationId" : "manage_payment_sources",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "business_entity_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity.\n\n**Note** [Multiple Business Entities](/docs/api/business_entities) is a feature available only on Product Catalog 2.0.\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.\n\n**Note** :\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 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.\n* Redirect URL configured in Settings \\> Hosted Pages Settings would be overriden by this redirect URL.\n* *Eg :* *http://yoursite.com?id=\\*\\*\\&state=succeeded*\n* This parameter is not applicable for iframe messaging.\n",
                    "maxLength" : 250,
                    "example" : null
                  },
                  "customer" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for customer\n",
                    "properties" : {
                      "id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Identifier of the customer.\n",
                        "maxLength" : 50,
                        "example" : null
                      }
                    },
                    "required" : [ "id" ],
                    "example" : null
                  },
                  "card" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for card\n",
                    "properties" : {
                      "gateway_account_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The gateway account in which this payment source is stored.\n",
                        "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\n"
                    }
                  },
                  "required" : [ "hosted_page" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/hosted_pages/checkout_existing" : {
      "post" : {
        "tags" : [ "hosted_pages" ],
        "summary" : "Checkout existing subscription",
        "description" : "You can checkout an existing subscription(typically in the trial state) by passing in the plan, quantity and addon details(like [Update a Subscription](/docs/api/v2/pcv-1/subscriptions/update-a-subscription))\n\nWhen the redirect URL is notified of the result, we would advise you to [retrieve the subscription](/docs/api/subscriptions/retrieve-a-subscription) and verify the details.\n\n#### Related Tutorial\n\n* [Upgrade existing subscription using Chargebee's hosted page](https://www.chargebee.com/tutorials/chargebee-js-checkout-existing-subscription/)\n\nAs mentioned before this behavior is very similar to the update subscription API call. All the web hook events will be fired only after the submission of payment details by the customer and successful checkout of subscription.\nAny errors related to the payment form that is submitted is handled as a response within the form so that the user is kept informed about the reason for failure to take corrective action.\n",
        "operationId" : "checkout_existing_subscription",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "replace_addon_list" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "Should be true if the existing addons should be replaced with the ones that are being passed.\n",
                    "example" : null
                  },
                  "mandatory_addons_to_remove" : {
                    "type" : "array",
                    "deprecated" : false,
                    "description" : "List of addons IDs that are mandatory to the plan and has to be removed from the subscription.\n",
                    "items" : {
                      "type" : "string",
                      "deprecated" : false,
                      "maxLength" : 100,
                      "example" : null
                    },
                    "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`\nis set to `true`\n, 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`.\nWhen passing this parameter, the following prerequisites must be met:\n\n* `invoice_date` must be in the past.\n* `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.\n* It is not earlier than `changes_scheduled_at`, `reactivate_from`, or `trial_end`.\n* `invoice_immediately` is `true`. .\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 is used.\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).\nIf a new term is started for the subscription due to this API call, then `terms_to_charge`\nis inclusive of this new term. See description for the `force_term_reset`\nparameter to learn more about when a subscription term is reset.\n",
                    "minimum" : 1,
                    "example" : null
                  },
                  "reactivate_from" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "If the subscription `status`\nis `cancelled`\nand it is being reactivated via this operation, this is the date/time at which the subscription should be reactivated.\n**Note:**\nIt is recommended not to pass this parameter along with `changed_scheduled_at`.\n`reactivate_from`\ncan 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:\n\n* Backdating must be enabled for subscription reactivation operations.\n* 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.\n* The date is on or after the last date/time any of the product catalog items of the subscription were changed.\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
                  },
                  "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)\nchosen for the site for calendar billing. Only applicable when using calendar billing.\n\n* delayed - Subscription period will be aligned with the configured billing date at the next renewal.\n* immediate - Subscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..\n",
                    "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.\n",
                    "items" : {
                      "type" : "string",
                      "deprecated" : false,
                      "maxLength" : 100,
                      "example" : null
                    },
                    "example" : null
                  },
                  "replace_coupon_list" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "If `true`\nthen the existing `coupon_ids`\nlist for the subscription is replaced by the one provided. If `false`\nthen the provided `coupon_ids`\nlist gets added to the existing list.\n",
                    "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.\n",
                    "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 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 has a different billing period from the current plan, the subscription term resets automatically, regardless of the value of `force_term_reset`.\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.\n\n**Note** :\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 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.\n* Redirect URL configured in Settings \\> Hosted Pages Settings would be overriden by this redirect URL.\n* *Eg :* *http://yoursite.com?id=\\*\\*\\&state=succeeded*\n* This parameter is not applicable for iframe messaging.\n",
                    "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.\n\n**Note**\n: - Cancel URL configured in Settings \\> Hosted Pages Settings would be overriden by this cancel URL.\n\n*Eg : http://yoursite.com?id=\\&state=cancelled*\n\n* This parameter is not applicable for iframe messaging and [in-app](https://www.chargebee.com/docs/2.0/checkout.html) checkout.\n",
                    "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.\nFor 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/v2/pcv-1/hosted_pages/checkout-existing-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.\n",
                    "maxLength" : 2048,
                    "example" : null
                  },
                  "embed" : {
                    "type" : "boolean",
                    "default" : true,
                    "deprecated" : false,
                    "description" : "If true then hosted page formatted to be shown in iframe. If false, it is formatted to be shown as a separate page.\n\n**Note**\n: For [in-app](https://www.chargebee.com/docs/checkout-v3.html)\ncheckout, default is false.\n",
                    "example" : null
                  },
                  "iframe_messaging" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "If true then iframe will communicate with the parent window. Applicable only for embedded(iframe) hosted pages. If you're using iframe_messaging you need to implement onSuccess \\& onCancel callbacks.\n\n**Note**\n: This parameter is not applicable for [in-app](https://www.chargebee.com/docs/checkout-v3.html)\ncheckout.\n",
                    "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.\n",
                    "example" : null
                  },
                  "subscription" : {
                    "type" : "object",
                    "additionalProperties" : true,
                    "deprecated" : false,
                    "description" : "Parameters for subscription\n",
                    "properties" : {
                      "id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "A unique and immutable identifier for the subscription. If not provided, it is autogenerated.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "plan_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Identifier of the plan for this subscription\n",
                        "maxLength" : 100,
                        "example" : null
                      },
                      "plan_quantity" : {
                        "type" : "integer",
                        "format" : "int32",
                        "default" : 1,
                        "deprecated" : false,
                        "description" : "Represents the plan quantity for this subscription.\n",
                        "minimum" : 1,
                        "example" : null
                      },
                      "plan_unit_price" : {
                        "type" : "integer",
                        "format" : "int64",
                        "deprecated" : false,
                        "description" : "Amount that will override the Plan's default price. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                        "minimum" : 0,
                        "example" : null
                      },
                      "setup_fee" : {
                        "type" : "integer",
                        "format" : "int64",
                        "deprecated" : false,
                        "description" : "Amount that will override the default setup fee. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                        "minimum" : 0,
                        "example" : null
                      },
                      "plan_quantity_in_decimal" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "maxLength" : 33,
                        "example" : null
                      },
                      "plan_unit_price_in_decimal" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "When price overriding is enabled for the site, the price or per-unit price of the plan can be set here. The value [set for the plan](/docs/api/v2/pcv-1/plans/plan-object#price)\nis used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "maxLength" : 39,
                        "example" : null
                      },
                      "start_date" : {
                        "type" : "integer",
                        "format" : "unix-time",
                        "deprecated" : false,
                        "description" : "The new start date of a `future`\nsubscription. Applicable only for `future`\nsubscriptions.\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. This is only allowed when the subscription `status`\nis `future`\n, `in_trial`\n, or `cancelled`.\nAlso, the value must not be earlier than `changes_scheduled_at`\nor `start_date`.\n**Note** :\nThis parameter can be backdated (set to a value in the past) only when the subscription is in `cancelled`\nor `in_trial`\n`status`.\nDo this to keep a record of when the trial ended in case it ended at some point in the past. When `trial_end`\nis backdated, the subscription immediately goes into `active`\nor `non_renewing`\nstatus. This parameter overrides the Plan's [`trial_period`](/docs/api/v2/pcv-1/plans)\ndirectly.\n",
                        "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.\n\n* off - Automatic collection of charges will not be made for this subscription. Use this for offline payments.\n* on - Whenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.\n",
                        "enum" : [ "on", "off" ],
                        "example" : null
                      },
                      "offline_payment_method" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The preferred offline payment method for the subscription.\n\n* uk_automated_bank_transfer - UK Automated Bank Transfer\n* us_automated_bank_transfer - US Automated Bank Transfer\n* boleto - Boleto\n* no_preference - No Preference\n* sepa_credit - SEPA Credit\n* jp_automated_bank_transfer - JP Automated Bank Transfer\n* mx_automated_bank_transfer - MX Automated Bank Transfer\n* bank_transfer - Bank Transfer\n* ach_credit - ACH Credit\n* custom - Custom\n* eu_automated_bank_transfer - EU Automated Bank Transfer\n* cash - Cash\n* check - Check\n",
                        "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)\ndisplayed on the invoice PDF.\n",
                        "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`\nor a custom value depending on the [site configuration](https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms)\n.\n",
                        "maximum" : 100,
                        "minimum" : 1,
                        "example" : null
                      }
                    },
                    "required" : [ "id" ],
                    "example" : null
                  },
                  "customer" : {
                    "type" : "object",
                    "additionalProperties" : true,
                    "deprecated" : false,
                    "description" : "Parameters for customer\n",
                    "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)\n\n`country`\nas\n`XI`\n(which is **United Kingdom - Northern Ireland**\n), the first two characters of the [full VAT number](https://en.wikipedia.org/wiki/VAT_identification_number)\ncan be overridden by setting\n[vat_number_prefix](/docs/api/customers/customer-object#vat_number_prefix)\n.\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).\nOnly applicable specifically for customers with [billing_address](/docs/api/customers/customer-object#billing_address)\n\n`country`\nas `XI`\n(which is **United Kingdom - Northern Ireland**\n).\n\nWhen you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\nin 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\nthe Brexit configuration, you have the option of setting [billing_address](/docs/api/customers/customer-object#billing_address)\n\n`country`\nas `XI`.\nThat's the code for **United Kingdom - Northern Ireland** .\nThe first two characters of the VAT number in such a case is\n`XI`\nby default. However, if the VAT number was registered in UK, the value should be `GB`.\nSet\n`vat_number_prefix`\nto `GB`\nfor such cases.\n",
                        "maxLength" : 10,
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "card" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for card\n",
                    "properties" : {
                      "gateway_account_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The gateway account in which this payment source is stored.\n",
                        "maxLength" : 50,
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "contract_term" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for contract_term\n",
                    "properties" : {
                      "action_at_term_end" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Action to be taken when the contract term completes.\n\n* evergreen - Contract term completes and the subscription renews.\n* renew -\n  * 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).\n  * 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`](/docs/api/contract_terms/contract_term-object#contract_end)\n, 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.\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "Identifier of the addon. Multiple addons can be passed.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "default" : 1,
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price" : {
                        "type" : "array",
                        "description" : "The price or per-unit-price of the addon. The value depends on the [type of currency](/docs/api/getting-started).  \n**Note:**\n\nFor recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the [addon period](/docs/api/v2/pcv-1/addons/addon-object#period). For example, consider the following details:\n\n* The `unit_price` provided is $10\n* The addon billing period is 1 month.\n* The plan billing period is 3 months.\n* The addon is only billed for $10 on each subscription renewal.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "billing_cycles" : {
                        "type" : "array",
                        "description" : "Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_in_decimal" : {
                        "type" : "array",
                        "description" : "The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 33,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price_in_decimal" : {
                        "type" : "array",
                        "description" : "When [price overriding](http://chargebee.com/docs/price-override.html )\nis enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)\nis used by default. However, the price provided here is considered as the price of the addon for an entire billing cycle of the subscription regardless of the value of the addon `period`.\nProvide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "event_based_addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for event_based_addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "A unique 'id' used to identify the addon.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price" : {
                        "type" : "array",
                        "description" : "Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "service_period_in_days" : {
                        "type" : "array",
                        "description" : "Defines service period of the addon in days from the day of charge.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "maximum" : 4000,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "charge_on" : {
                        "type" : "array",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "description" : "Indicates when the non-recurring addon will be charged.\n\n* on_event - Charge for the addon will be applied on the occurrence of a specified event.\n* immediately - Charges for the addon will be applied immediately.\n",
                          "enum" : [ "immediately", "on_event" ],
                          "example" : null
                        },
                        "example" : null
                      },
                      "on_event" : {
                        "type" : "array",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "description" : "Event on which this addon will be charged.\n\n* plan_activation - Addon will be charged on plan activation.\n* subscription_activation - Addon will be charged on subscription activation.\n* subscription_creation - Addon will be charged on subscription creation.\n* subscription_trial_start - Addon will be charged when the trial period starts.\n* contract_termination - Addon will be charged on contract termination.\n",
                          "enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ],
                          "example" : null
                        },
                        "example" : null
                      },
                      "charge_once" : {
                        "type" : "array",
                        "description" : "If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.\n",
                        "items" : {
                          "type" : "boolean",
                          "default" : true,
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_in_decimal" : {
                        "type" : "array",
                        "description" : "The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 33,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price_in_decimal" : {
                        "type" : "array",
                        "description" : "When [price overriding](http://chargebee.com/docs/price-override.html )\nis enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)\nis used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  }
                },
                "example" : null
              },
              "encoding" : {
                "addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "card" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "contract_term" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "customer" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "event_based_addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "subscription" : {
                  "style" : "deepObject",
                  "explode" : true
                }
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "hosted_page" : {
                      "$ref" : "#/components/schemas/HostedPage",
                      "description" : "Resource object representing hosted_page\n"
                    }
                  },
                  "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)\nfrom 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.\n",
          "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`.\n",
          "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.\n",
          "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.\n",
          "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.\n\n* exclusive - Excludes only **exclusive** tax calculations, and only when exclusive taxes are applicable.\n* none - No exclusions are applied. All applicable taxes are calculated based on the standard tax configuration.\n",
          "required" : false,
          "deprecated" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "default" : "none",
            "deprecated" : false,
            "enum" : [ "exclusive", "none" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "subscription-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/subscription-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "estimate" : {
                      "$ref" : "#/components/schemas/Estimate",
                      "description" : "Resource object representing estimate\n"
                    }
                  },
                  "required" : [ "estimate" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/estimates/update_subscription" : {
      "post" : {
        "tags" : [ "estimates" ],
        "summary" : "Update subscription estimate",
        "description" : "Generates an estimate for the 'update subscription' operation. The input will be similar to the [Update Subscription](/docs/api/v2/pcv-1/subscriptions/update-a-subscription) API but subscription will not be updated, only an estimate will be created.\n\nIn the response,\n\n* [subscription_estimate](/docs/api/estimates/estimate-object): The details of the changed subscription such as `status`, next billing date, and so on.\n* [invoice_estimate](/docs/api/estimates/estimate-object):The details of the immediate invoice, if it is generated. An immediate invoice is not generated when:\n  * `end_of_term` parameter is true\n  * `prorate` parameter is `false`\n  * No changes are made to `subscription` or `addons`.\n  * For changes such as [quantity downgrades](https://www.chargebee.com/docs/proration.html#proration-mechanism_plan-quantity-downgrade-paid-invoice).\n* [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.\n* [credit_note_estimates](/docs/api/estimates/estimate-object):The list of credit notes (if any) generated during this operation.\n* [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`.\n\n**Note:** If you have configured [EU VAT](https://www.chargebee.com/docs/eu-vat.html) or [Customized taxes](https://www.chargebee.com/docs/customized-tax.html), you need to specify the applicable parameters for calculating taxes - *billing_address\\[\\]* , *shipping_address\\[\\]* , *customer\\[vat_number\\]* , *customer\\[taxability\\]* etc. Otherwise tax calculation will be ignored.\n",
        "operationId" : "update_subscription_estimate",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "changes_scheduled_at" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "When `change_option`\nis set to `specific_date`\n, then set the date/time at which the subscription change is to happen or has happened. **Note:**\nIt is recommended not to pass this parameter along with `reactivate_from`.\n`changes_scheduled_at`\ncan 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\n* Only the following changes can be backdated:\n\n* Changes in the recurring items or their prices.\n\n* Addition of non-recurring items.\n\n* Subscription `status` is `active`, `cancelled`, or `non_renewing`.\n\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\n* The date is on or after `current_term_start`.\n\n* The date is on or after the last date/time any of the following changes were made:\n\n* Changes in the recurring items or their prices.\n\n* Addition of non-recurring items.\n\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  .\n\n",
                    "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.\n\n* end_of_term - The change is carried out at the end of the current billing cycle of the subscription.\n* specific_date -\n  The change is carried out as of the date specified under `changes_scheduled_at`\n  .\n* immediately - The change is carried out immediately.\n",
                    "enum" : [ "immediately", "end_of_term", "specific_date" ],
                    "example" : null
                  },
                  "replace_addon_list" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "Should be true if the existing addons should be replaced with the ones that are being passed.\n",
                    "example" : null
                  },
                  "mandatory_addons_to_remove" : {
                    "type" : "array",
                    "deprecated" : false,
                    "description" : "List of addons IDs that are mandatory to the plan and has to be removed from the subscription.\n",
                    "items" : {
                      "type" : "string",
                      "deprecated" : false,
                      "maxLength" : 100,
                      "example" : null
                    },
                    "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`\nis set to `true`\n, 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`.\nWhen passing this parameter, the following prerequisites must be met:\n\n* `invoice_date` must be in the past.\n* `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.\n* It is not earlier than `changes_scheduled_at`, `reactivate_from`, or `trial_end`.\n* `invoice_immediately` is `true`. .\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 is used.\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).\nIf a new term is started for the subscription due to this API call, then `terms_to_charge`\nis inclusive of this new term. See description for the `force_term_reset`\nparameter to learn more about when a subscription term is reset.\n",
                    "minimum" : 1,
                    "example" : null
                  },
                  "reactivate_from" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "If the subscription `status`\nis `cancelled`\nand it is being reactivated via this operation, this is the date/time at which the subscription should be reactivated.\n**Note:**\nIt is recommended not to pass this parameter along with `changed_scheduled_at`.\n`reactivate_from`\ncan 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:\n\n* Backdating must be enabled for subscription reactivation operations.\n* 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.\n* The date is on or after the last date/time any of the product catalog items of the subscription were changed.\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
                  },
                  "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)\nchosen for the site for calendar billing. Only applicable when using calendar billing.\n\n* immediate - Subscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..\n* delayed - Subscription period will be aligned with the configured billing date at the next renewal.\n",
                    "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)\n.\n",
                    "items" : {
                      "type" : "string",
                      "deprecated" : false,
                      "maxLength" : 100,
                      "example" : null
                    },
                    "example" : null
                  },
                  "replace_coupon_list" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "If `true`\nthen the existing `coupon_ids`\nlist for the subscription is replaced by the one provided. If `false`\nthen the provided list gets added to the existing `coupon_ids`\n.\n",
                    "example" : null
                  },
                  "prorate" : {
                    "type" : "boolean",
                    "deprecated" : false,
                    "description" : "* When `true`: [Prorated credits or charges](https://www.chargebee.com/docs/1.0/proration.html#proration-mechanism) are created as applicable for this change.\n* When `false`: The subscription is changed without creating any credits or charges.\n* When not provided, the value configured in the [site settings](https://www.chargebee.com/docs/1.0/proration.html#proration-for-subscription-change) is considered.\n\n**Caveat**\n\nFor further changes within the same billing term, when `prorate` is set to `true`, **credits** are **not created** when **all** the conditions below hold true:\n\nAn immediate previous change was made\n\n* with `prorate` set to `false` and\n* no changes were made to the subscription's billing term and\n* a change was made to either the subscription's plan, its addons, or the prices of the plan or addons.\n",
                    "example" : null
                  },
                  "end_of_term" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "Set this to true if you want the update to be applied at the end of the current subscription billing cycle.\n",
                    "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`\nwill have the subscription reset its term to the current date (provided `end_of_term`\nis false).\n**Note**:\nWhen 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.\n",
                    "example" : null
                  },
                  "reactivate" : {
                    "type" : "boolean",
                    "deprecated" : false,
                    "description" : "Applicable only for `cancelled`\nsubscriptions. When passed as `true`\n, the canceled subscription is activated; otherwise subscription changes are made without changing its `status`.\nIf not passed, subscription will be activated only if `subscription_items`\nis passed.\n",
                    "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.\n",
                    "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*\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).\nThe 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
                  },
                  "subscription" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for subscription\n",
                    "properties" : {
                      "id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "A unique and immutable identifier for the subscription. If not provided, it is autogenerated.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "plan_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Identifier of the plan for this subscription\n",
                        "maxLength" : 100,
                        "example" : null
                      },
                      "plan_quantity" : {
                        "type" : "integer",
                        "format" : "int32",
                        "default" : 1,
                        "deprecated" : false,
                        "description" : "Represents the plan quantity for this subscription.\n",
                        "minimum" : 1,
                        "example" : null
                      },
                      "plan_unit_price" : {
                        "type" : "integer",
                        "format" : "int64",
                        "deprecated" : false,
                        "description" : "Amount that will override the Plan's default price. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                        "minimum" : 0,
                        "example" : null
                      },
                      "setup_fee" : {
                        "type" : "integer",
                        "format" : "int64",
                        "deprecated" : false,
                        "description" : "Amount that will override the default setup fee. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                        "minimum" : 0,
                        "example" : null
                      },
                      "plan_quantity_in_decimal" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "maxLength" : 33,
                        "example" : null
                      },
                      "plan_unit_price_in_decimal" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "When price overriding is enabled for the site, the price or per-unit price of the plan can be set here. The value [set for the plan](/docs/api/v2/pcv-1/plans/plan-object#price)\nis used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "maxLength" : 39,
                        "example" : null
                      },
                      "start_date" : {
                        "type" : "integer",
                        "format" : "unix-time",
                        "deprecated" : false,
                        "description" : "The new start date of a `future`\nsubscription. Applicable only for `future`\nsubscriptions.\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. This is only allowed when the subscription `status`\nis `future`\n, `in_trial`\n, or `cancelled`.\nAlso, the value must not be earlier than `changes_scheduled_at`\nor `start_date`.\n**Note** :\nThis parameter can be backdated (set to a value in the past) only when the subscription is in `cancelled`\nor `in_trial`\n`status`.\nDo this to keep a record of when the trial ended in case it ended at some point in the past. When `trial_end`\nis backdated, the subscription immediately goes into `active`\nor `non_renewing`\nstatus.\n",
                        "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.\n\n* off - Automatic collection of charges will not be made for this subscription. Use this for offline payments.\n* on - Whenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.\n",
                        "enum" : [ "on", "off" ],
                        "example" : null
                      },
                      "offline_payment_method" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The preferred offline payment method for the subscription.\n\n* uk_automated_bank_transfer - UK Automated Bank Transfer\n* jp_automated_bank_transfer - JP Automated Bank Transfer\n* bank_transfer - Bank Transfer\n* us_automated_bank_transfer - US Automated Bank Transfer\n* boleto - Boleto\n* no_preference - No Preference\n* sepa_credit - SEPA Credit\n* mx_automated_bank_transfer - MX Automated Bank Transfer\n* ach_credit - ACH Credit\n* custom - Custom\n* eu_automated_bank_transfer - EU Automated Bank Transfer\n* cash - Cash\n* check - Check\n",
                        "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.\n",
                        "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)\nattribute of the [plan](/docs/api/v2/pcv-1/subscriptions/create-a-subscription#plan_id)\nchosen.\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
                      },
                      "trial_end_action" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Applicable only when [End-of-trial Action](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)\nhas 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.\n\n* activate_subscription - The subscription activates and charges are raised for non-metered items.\n* cancel_subscription - The subscription cancels.\n* plan_default -\n  The action [configured for the site](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)\n  at the time when the trial ends, takes effect. This is the default value when `trial_end_action`\n  is defined for the plan.\n* site_default -\n  The action [configured for the site](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)\n  at the time when the trial ends, takes effect. This is the default value when `trial_end_action`\n  is **not**\n  defined for the plan.\n",
                        "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\n",
                    "properties" : {
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line3" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 3\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n).\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.\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://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.\n\n* valid - Address was validated successfully.\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n",
                        "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "shipping_address" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for shipping_address\n",
                    "properties" : {
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line3" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 3\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n).\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.\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://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.\n\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n* valid - Address was validated successfully.\n",
                        "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "customer" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for customer\n",
                    "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.\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).\nOnly applicable specifically for customers with [billing_address](/docs/api/customers/customer-object#billing_address)\n\n`country`\nas `XI`\n(which is **United Kingdom - Northern Ireland**\n).\n\nWhen you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\nin 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\nthe Brexit configuration, you have the option of setting [billing_address](/docs/api/customers/customer-object#billing_address)\n\n`country`\nas `XI`.\nThat's the code for **United Kingdom - Northern Ireland** .\nThe first two characters of the VAT number in such a case is\n`XI`\nby default. However, if the VAT number was registered in UK, the value should be `GB`.\nSet\n`vat_number_prefix`\nto `GB`\nfor such cases.\n",
                        "maxLength" : 10,
                        "example" : null
                      },
                      "registered_for_gst" : {
                        "type" : "boolean",
                        "deprecated" : false,
                        "description" : "Confirms that a customer is registered under GST. If set to `true`\nthen the [Reverse Charge Mechanism](https://www.chargebee.com/docs/australian-gst.html#reverse-charge-mechanism)\nis applicable. This field is applicable only when Australian GST is configured for your site.\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "Identifier of the addon. Multiple addons can be passed.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "default" : 1,
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price" : {
                        "type" : "array",
                        "description" : "The price or per-unit-price of the addon. The value depends on the [type of currency](/docs/api/getting-started).  \n**Note:**\n\nFor recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the [addon period](/docs/api/v2/pcv-1/addons/addon-object#period). For example, consider the following details:\n\n* The `unit_price` provided is $10\n* The addon billing period is 1 month.\n* The plan billing period is 3 months.\n* The addon is only billed for $10 on each subscription renewal.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "billing_cycles" : {
                        "type" : "array",
                        "description" : "Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_in_decimal" : {
                        "type" : "array",
                        "description" : "The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 33,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price_in_decimal" : {
                        "type" : "array",
                        "description" : "When [price overriding](http://chargebee.com/docs/price-override.html )\nis enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)\nis used by default. However, the price provided here is considered as the price of the addon for an entire billing cycle of the subscription regardless of the value of the addon `period`.\nProvide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      },
                      "trial_end" : {
                        "type" : "array",
                        "description" : "The time at which the trial ends for the addon. To update this value, redo the complete addon set using [`replace_addon_list`](/docs/api/v2/pcv-1/subscriptions/update-a-subscription#replace_addon_list).\n(Addon trial periods must be enabled by [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",
                        "items" : {
                          "type" : "integer",
                          "format" : "unix-time",
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      },
                      "proration_type" : {
                        "type" : "array",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "description" : "Specifies how to manage charges or credits for the addon for this estimate. It's relevant only for addons that have their [pricing_model](/docs/api/v2/pcv-1/addons/addon-object#pricing_model)\nset to `per_unit`.\nYou may use this parameter only if the change to the subscription takes effect [immediately](/docs/api/v2/pcv-1/estimates/update-subscription-estimate#end_of_term).  \n**Note**\nIf you don't provide a value, Chargebee determines the proration logic based on the following precedence: this parameter \\> [prorate](/docs/api/v2/pcv-1/subscriptions/update-a-subscription#prorate) parameter \\> [addon.proration_type](/docs/api/v2/pcv-1/addons/addon-object#proration_type) \\> [site-wide proration](https://www.chargebee.com/docs/1.0/proration.html#proration-for-subscription-change) setting.\n\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* none - Don't apply any charges or credits for the addon.\n",
                          "enum" : [ "full_term", "partial_term", "none" ],
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "event_based_addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for event_based_addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "A unique 'id' used to identify the addon.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price" : {
                        "type" : "array",
                        "description" : "Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "service_period_in_days" : {
                        "type" : "array",
                        "description" : "Defines service period of the addon in days from the day of charge.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "maximum" : 4000,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "charge_on" : {
                        "type" : "array",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "description" : "Indicates when the non-recurring addon will be charged.\n\n* immediately - Charges for the addon will be applied immediately.\n* on_event - Charge for the addon will be applied on the occurrence of a specified event.\n",
                          "enum" : [ "immediately", "on_event" ],
                          "example" : null
                        },
                        "example" : null
                      },
                      "on_event" : {
                        "type" : "array",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "description" : "Event on which this addon will be charged.\n\n* plan_activation - Addon will be charged on plan activation.\n* contract_termination - Addon will be charged on contract termination.\n* subscription_activation - Addon will be charged on subscription activation.\n* subscription_creation - Addon will be charged on subscription creation.\n* subscription_trial_start - Addon will be charged when the trial period starts.\n",
                          "enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ],
                          "example" : null
                        },
                        "example" : null
                      },
                      "charge_once" : {
                        "type" : "array",
                        "description" : "If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.\n",
                        "items" : {
                          "type" : "boolean",
                          "default" : true,
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_in_decimal" : {
                        "type" : "array",
                        "description" : "The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 33,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price_in_decimal" : {
                        "type" : "array",
                        "description" : "When [price overriding](http://chargebee.com/docs/price-override.html )\nis enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)\nis used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  }
                },
                "example" : null
              },
              "encoding" : {
                "addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "billing_address" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "customer" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "event_based_addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "shipping_address" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "subscription" : {
                  "style" : "deepObject",
                  "explode" : true
                }
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "estimate" : {
                      "$ref" : "#/components/schemas/Estimate",
                      "description" : "Resource object representing estimate\n"
                    }
                  },
                  "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" : "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.\n\n* immediately - Resume immediately\n* specific_date - Resume on a specific date\n",
                    "enum" : [ "immediately", "specific_date" ],
                    "example" : null
                  },
                  "charges_handling" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Applicable when charges get added during this operation and **resume_option**\nis set as 'immediately'. Allows to raise invoice immediately or add them to unbilled charges.\n\n* add_to_unbilled_charges - Add to unbilled charges\n* invoice_immediately - Invoice immediately\n",
                    "enum" : [ "invoice_immediately", "add_to_unbilled_charges" ],
                    "example" : null
                  },
                  "subscription" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for subscription\n",
                    "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.\n",
                        "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\n"
                    }
                  },
                  "required" : [ "estimate" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/estimates/gift_subscription" : {
      "post" : {
        "tags" : [ "estimates" ],
        "summary" : "Gift subscription estimate",
        "description" : "Generates an estimate for the 'create a gift' operation. This is similar to the [Create a gift](/docs/api/v2/pcv-1/gifts/create-a-gift) API, but the gift subscription will not be created. Only an estimate for this operation is created.\n\nIn the response,\n\n* **estimate.subscription_estimate** has the gift subscription details.\n* **estimate.invoice_estimate** has details of the gift invoice that will be generated immediately.\n",
        "operationId" : "gift_subscription_estimate",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "coupon_ids" : {
                    "type" : "array",
                    "deprecated" : false,
                    "description" : "List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.\n",
                    "items" : {
                      "type" : "string",
                      "deprecated" : false,
                      "maxLength" : 100,
                      "example" : null
                    },
                    "example" : null
                  },
                  "gift" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for gift\n",
                    "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.\n",
                        "example" : null
                      },
                      "auto_claim" : {
                        "type" : "boolean",
                        "default" : false,
                        "deprecated" : false,
                        "description" : "When `true`\n, the claim happens automatically. When not passed, the default value in the site settings is used.\n",
                        "example" : null
                      },
                      "no_expiry" : {
                        "type" : "boolean",
                        "deprecated" : false,
                        "description" : "When `true`\n, indicates that the gift does not expire. Do not pass or pass as `false`\nwhen `auto_claim`\nis set.\n",
                        "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`.\nIf the gift is not claimed within `claim_expiry_date`\n, it will expire and the subscription will move to `cancelled`\nstate. When not passed, the value specified in the site settings will be used.\nPass as `NULL`\nor do not pass when `auto_claim`\nor `no_expiry`\nare set.\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "gifter" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for gifter\n",
                    "properties" : {
                      "customer_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Gifter customer id.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "signature" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Gifter sign-off name\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "note" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Personalized message for the gift.\n",
                        "maxLength" : 500,
                        "example" : null
                      },
                      "payment_src_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Identifier of the payment source\n",
                        "maxLength" : 40,
                        "example" : null
                      }
                    },
                    "required" : [ "customer_id", "signature" ],
                    "example" : null
                  },
                  "gift_receiver" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for gift_receiver\n",
                    "properties" : {
                      "customer_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Receiver customer id.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "First name of the receiver as given by the gifter.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Last name of the receiver as given by the gifter,\n",
                        "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.\n",
                        "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\n",
                    "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.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "gateway_account_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The gateway account used for performing the 3DS flow.\n",
                        "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)\nto find out the gateway-specific gw_token format. Applicable when you are using gateway APIs directly for completing the 3DS flow.\n",
                        "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.\n\n* card - card\n* twint - Payments made via Twint\n* swish - Payments made via Swish\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* thai_qr - Payments made via Thai QR.\n* go_pay - Payments made via GoPay\n* google_pay - google_pay\n* trustly - Trustly\n* naver_pay - Payments made via Naver Pay.\n* stablecoin - Payments made via Stablecoin.\n* paypal_express_checkout - paypal_express_checkout\n* pix - Pix\n* venmo - Venmo\n* klarna_pay_now - Klarna Pay Now\n* alipay - Payments made via Alipay.\n* tamara - Payments made via Tamara.\n* ideal - ideal\n* picpay - Payments made via PicPay.\n* pay_to - PayTo\n* ovo - Payments made via OVO.\n* boleto - boleto\n* pay_co - Payments made via PayCo\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* alipay_hk - Payments made via Alipay HK.\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* mercado_pago - Payments made via Mercado Pago.\n* p24 - Payments made via Przelewy24 (P24).\n* electronic_payment_standard - Electronic Payment Standard\n* direct_debit - direct_debit\n* sepa_instant_transfer - Sepa Instant Transfer\n* bancontact - bancontact\n* wero - Payments made via Wero.\n* pay_by_bank - Pay By Bank\n* touch_n_go - Payments made via Touch 'n Go.\n* apple_pay - apple_pay\n* qpay - Payments made via Qpay.\n* online_banking_poland - Online Banking Poland\n* gcash - Payments made via GCash.\n* nupay - Payments made via NuPay.\n* giropay - giropay\n* momo - Payments made via MoMo.\n* sofort - sofort\n* amazon_payments - Amazon Payments\n* affirm_pay - Payments made via Affirm Pay.\n* kakao_pay - Payments made via Kakao Pay.\n* fpx - Payments made via FPX.\n* blik - Payments made via BLIK.\n* dana - Payments made via Dana.\n* south_korean_cards - Payments made via South Korean Cards\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.\n",
                        "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).\n\n  * `payer`: User related information.\n    * `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).\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `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.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n    * `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.\n* `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions.\n\n  * `fraud`: Fraud identification related information.\n    * `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.\n* `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.\n\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device.\n* `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.\n\n  * `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted.\n* `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.\n\n  * `payer`: User related information.\n    * `document`: Document is the user's identification number based on their country.\n  * `fraud`: Fraud identification related information.\n    * `device_session_id`: Session ID associated with the user's device\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "shipping_address" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for shipping_address\n",
                    "properties" : {
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The first name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The last name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "The email address.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "company" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The company name.\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The phone number.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line3" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 3\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n).\n",
                        "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`\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.\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://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.\n\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n* valid - Address was validated successfully.\n",
                        "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "subscription" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for subscription\n",
                    "properties" : {
                      "plan_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Identifier of the plan for this subscription\n",
                        "maxLength" : 100,
                        "example" : null
                      },
                      "plan_quantity" : {
                        "type" : "integer",
                        "format" : "int32",
                        "default" : 1,
                        "deprecated" : false,
                        "description" : "Plan quantity for this subscription\n",
                        "minimum" : 1,
                        "example" : null
                      },
                      "plan_quantity_in_decimal" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Plan Quantity for this subscription in Multi Decimal\n",
                        "maxLength" : 33,
                        "example" : null
                      }
                    },
                    "required" : [ "plan_id" ],
                    "example" : null
                  },
                  "addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "Identifier of the addon. Multiple addons can be passed.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "default" : 1,
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_in_decimal" : {
                        "type" : "array",
                        "description" : "The decimal representation of the quantity of the addon. Returned for quantity-based plans when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 33,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  }
                },
                "example" : null
              },
              "encoding" : {
                "addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "gift" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "gift_receiver" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "gifter" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "payment_intent" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "shipping_address" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "subscription" : {
                  "style" : "deepObject",
                  "explode" : true
                }
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "estimate" : {
                      "$ref" : "#/components/schemas/Estimate",
                      "description" : "Resource object representing estimate\n"
                    }
                  },
                  "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).\n\nIn the response:\n\n* **estimate.invoice_estimates\\[\\]** has details of the invoices scheduled to be generated.\n\n**Note:** If *consolidated invoicing* is enabled you may use this API to test whether upcoming renewals are consolidated.\n",
        "operationId" : "upcoming_invoices_estimate",
        "parameters" : [ {
          "name" : "include_usage_charges",
          "in" : "query",
          "description" : "When set to true, each invoice estimate in the response will include usage context for metered items and estimate any usage charges (on-demand/overage) that would be invoiced.\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" : "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\n"
                    }
                  },
                  "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:\n\n* An invoice exists for the current term and its `status` is not `voided`.\n* There are [unbilled charges](https://www.chargebee.com/docs/unbilled-charges.html) for the current term.\n* The subscription has an [advance invoice](https://www.chargebee.com/docs/advance-invoices.html).\n\n#### Response\n\nReturns an `estimate` object with one of the following components depending on the value of `invoice_immediately`.\n\n* If the value is `true`: an `invoice_estimate` object that corresponds to the regenerated invoice.\n* 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.\n",
        "operationId" : "regenerate_invoice_estimate",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "subscription-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/subscription-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "date_from" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "The start date of the period being invoiced. The default value is [current_term_start](/docs/api/subscriptions/subscription-object#current_term_start)\n.\n",
                    "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)\n.\n",
                    "example" : null
                  },
                  "prorate" : {
                    "type" : "boolean",
                    "deprecated" : false,
                    "description" : "Whether the charges should be prorated according to the term specified by `date_from`\nand `date_to`.\nShould not be passed without `date_from`\nand `date_to`\n.\n",
                    "example" : null
                  },
                  "invoice_immediately" : {
                    "type" : "boolean",
                    "deprecated" : false,
                    "description" : "Only applicable when [Consolidated Invoicing](https://www.chargebee.com/docs/consolidated-invoicing.html )\nis enabled for the customer. Set to `false`\nto leave the current term charge for the subscription as [unbilled](https://www.chargebee.com/docs/unbilled-charges.html ).\nOnce 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)\nto invoice them.\n",
                    "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\n"
                    }
                  },
                  "required" : [ "estimate" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/customers/{customer-id}/create_subscription_estimate" : {
      "get" : {
        "tags" : [ "customers" ],
        "summary" : "Create subscription for a customer estimate",
        "description" : "Create a subscription for the existing estimate of a customer.\n",
        "operationId" : "create_subscription_for_a_customer_estimate",
        "parameters" : [ {
          "name" : "use_existing_balances",
          "in" : "query",
          "description" : "The generated invoice_estimate/next_invoice_estimate will include all the balances - Promotional Credits, Refundable Credits, and Excess Payments - if any. If you don't want these balances to be included you can specify 'false' for the parameter *use_existing_balances*\n.\n",
          "required" : false,
          "deprecated" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "boolean",
            "default" : true,
            "deprecated" : false,
            "example" : null
          }
        }, {
          "name" : "invoice_immediately",
          "in" : "query",
          "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).\nThe 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",
          "required" : false,
          "deprecated" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "boolean",
            "deprecated" : false,
            "example" : null
          }
        }, {
          "name" : "billing_cycles",
          "in" : "query",
          "description" : "Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.\n",
          "required" : false,
          "deprecated" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "integer",
            "format" : "int32",
            "deprecated" : false,
            "minimum" : 0,
            "example" : null
          }
        }, {
          "name" : "mandatory_addons_to_remove",
          "in" : "query",
          "description" : "List of addons IDs that are mandatory to the plan and has to be removed from the subscription.\n",
          "required" : false,
          "deprecated" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "array",
            "deprecated" : false,
            "items" : {
              "type" : "string",
              "deprecated" : false,
              "x-cb-parameter-blank-option" : "as_null",
              "x-cb-attribute-meta-comment" : "optional",
              "x-cb-is-api-column" : true,
              "maxLength" : 100,
              "example" : null
            },
            "example" : null
          }
        }, {
          "name" : "terms_to_charge",
          "in" : "query",
          "description" : "The number of subscription billing cycles (including the first one) to [invoice in advance](https://www.chargebee.com/docs/advance-invoices.html)\n.\n",
          "required" : false,
          "deprecated" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "integer",
            "format" : "int32",
            "deprecated" : false,
            "minimum" : 1,
            "example" : null
          }
        }, {
          "name" : "billing_alignment_mode",
          "in" : "query",
          "description" : "Override the [billing alignment mode](https://www.chargebee.com/docs/calendar-billing.html#alignment-of-billing-date)\nfor Calendar Billing. Only applicable when using Calendar Billing. The default value is that which has been configured for the site.\n\n* delayed - Subscription period will be aligned with the configured billing date at the next renewal.\n* immediate - Subscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..\n",
          "required" : false,
          "deprecated" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "deprecated" : false,
            "enum" : [ "immediate", "delayed" ],
            "example" : null
          }
        }, {
          "name" : "invoice_date",
          "in" : "query",
          "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.\n`taxes`\nand\n`line_item_taxes`\nare 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.\n",
          "required" : false,
          "deprecated" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "example" : null
          }
        }, {
          "name" : "coupon_ids",
          "in" : "query",
          "description" : "List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.\n",
          "required" : false,
          "deprecated" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "array",
            "deprecated" : false,
            "items" : {
              "type" : "string",
              "deprecated" : false,
              "x-cb-parameter-blank-option" : "as_null",
              "x-cb-attribute-meta-comment" : "optional",
              "x-cb-is-api-column" : true,
              "maxLength" : 100,
              "example" : null
            },
            "example" : null
          }
        }, {
          "name" : "subscription",
          "in" : "query",
          "description" : "Parameters for subscription\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "properties" : {
              "id" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "A unique and immutable identifier for the subscription. If not provided, it is autogenerated.\n",
                "maxLength" : 50,
                "example" : null
              },
              "plan_id" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Identifier of the plan for this subscription\n",
                "maxLength" : 100,
                "example" : null
              },
              "plan_quantity" : {
                "type" : "integer",
                "format" : "int32",
                "default" : 1,
                "deprecated" : false,
                "description" : "Plan quantity for this subscription\n",
                "minimum" : 1,
                "example" : null
              },
              "plan_quantity_in_decimal" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                "maxLength" : 33,
                "example" : null
              },
              "plan_unit_price" : {
                "type" : "integer",
                "format" : "int64",
                "deprecated" : false,
                "description" : "Amount that will override the Plan's default price. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                "minimum" : 0,
                "example" : null
              },
              "plan_unit_price_in_decimal" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "When [price overriding](http://chargebee.com/docs/price-override.html )\nis enabled for the site, the price or per-unit price of the plan can be set here. The value [set for the plan](/docs/api/v2/pcv-1/plans/plan-object#price)\nis used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                "maxLength" : 39,
                "example" : null
              },
              "setup_fee" : {
                "type" : "integer",
                "format" : "int64",
                "deprecated" : false,
                "description" : "Amount that will override the default setup fee. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                "minimum" : 0,
                "example" : null
              },
              "trial_end" : {
                "type" : "integer",
                "format" : "unix-time",
                "deprecated" : false,
                "description" : "The time at which the trial ends for this subscription. Can be specified to override the default trial period.If **'0'**\nis passed, the subscription will be activated immediately.\n",
                "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:\n\n* Backdating is enabled for subscription creation operations.\n* 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.\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, `start_date` cannot be earlier than 14th February.\n",
                "example" : null
              },
              "offline_payment_method" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The preferred offline payment method for the subscription.\n",
                "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.\n",
                "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)\nattribute of the [plan](/docs/api/v2/pcv-1/subscriptions/create-a-subscription#plan_id)\nchosen.\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`\nor a custom value depending on the [site configuration](https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms)\n.\n",
                "maximum" : 100,
                "minimum" : 1,
                "example" : null
              },
              "trial_end_action" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Applicable only when [End-of-trial Action](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)\nhas 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.\n",
                "enum" : [ "site_default", "plan_default", "activate_subscription", "cancel_subscription" ],
                "example" : null
              }
            },
            "required" : [ "plan_id" ],
            "example" : null
          }
        }, {
          "name" : "shipping_address",
          "in" : "query",
          "description" : "Parameters for shipping_address\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "properties" : {
              "line1" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Address line 1\n",
                "maxLength" : 150,
                "example" : null
              },
              "line2" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Address line 2\n",
                "maxLength" : 150,
                "example" : null
              },
              "line3" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Address line 3\n",
                "maxLength" : 150,
                "example" : null
              },
              "city" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n).\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.\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://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.\n",
                "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                "example" : null
              }
            },
            "example" : null
          }
        }, {
          "name" : "contract_term",
          "in" : "query",
          "description" : "Parameters for contract_term\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "properties" : {
              "action_at_term_end" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Action to be taken when the contract term completes.\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`](/docs/api/contract_terms/contract_term-object#contract_end)\n, 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.\n",
                "example" : null
              }
            },
            "example" : null
          }
        }, {
          "name" : "addons",
          "in" : "query",
          "description" : "Parameters for addons\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "properties" : {
              "id" : {
                "type" : "array",
                "description" : "Identifier of the addon. Multiple addons can be passed.\n",
                "items" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 100,
                  "example" : null
                },
                "example" : null
              },
              "quantity" : {
                "type" : "array",
                "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                "items" : {
                  "type" : "integer",
                  "format" : "int32",
                  "default" : 1,
                  "deprecated" : false,
                  "minimum" : 1,
                  "example" : null
                },
                "example" : null
              },
              "quantity_in_decimal" : {
                "type" : "array",
                "description" : "The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis 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 addon. The value depends on the [type of currency](/docs/api/getting-started).  \n**Note:**\n\nFor recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the [addon period](/docs/api/v2/pcv-1/addons/addon-object#period). For example, consider the following details:\n\n* The `unit_price` provided is $10\n* The addon billing period is 1 month.\n* The plan billing period is 3 months.\n* The addon is only billed for $10 on each subscription renewal.\n",
                "items" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "minimum" : 0,
                  "example" : null
                },
                "example" : null
              },
              "unit_price_in_decimal" : {
                "type" : "array",
                "description" : "When [price overriding](http://chargebee.com/docs/price-override.html )\nis enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)\nis used by default. However, the price provided here is considered as the price of the addon for an entire billing cycle of the subscription regardless of the value of the addon `period`.\nProvide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                "items" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 39,
                  "example" : null
                },
                "example" : null
              },
              "billing_cycles" : {
                "type" : "array",
                "description" : "Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.\n",
                "items" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "minimum" : 0,
                  "example" : null
                },
                "example" : null
              },
              "trial_end" : {
                "type" : "array",
                "description" : "The time at which the trial ends for the addon. This value can only be set for subscriptions that start with an `active`\nor `non-renewing`\nstatus. Once set, the value can't be changed. (Addon trial periods must be enabled by [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",
                "items" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "example" : null
                },
                "example" : null
              }
            },
            "example" : null
          }
        }, {
          "name" : "event_based_addons",
          "in" : "query",
          "description" : "Parameters for event_based_addons\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "properties" : {
              "id" : {
                "type" : "array",
                "description" : "A unique 'id' used to identify the addon.\n",
                "items" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 100,
                  "example" : null
                },
                "example" : null
              },
              "quantity" : {
                "type" : "array",
                "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                "items" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "minimum" : 1,
                  "example" : null
                },
                "example" : null
              },
              "unit_price" : {
                "type" : "array",
                "description" : "Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                "items" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "minimum" : 0,
                  "example" : null
                },
                "example" : null
              },
              "quantity_in_decimal" : {
                "type" : "array",
                "description" : "The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                "items" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 33,
                  "example" : null
                },
                "example" : null
              },
              "unit_price_in_decimal" : {
                "type" : "array",
                "description" : "When [price overriding](http://chargebee.com/docs/price-override.html )\nis enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)\nis used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                "items" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 39,
                  "example" : null
                },
                "example" : null
              },
              "service_period_in_days" : {
                "type" : "array",
                "description" : "Defines service period of the addon in days from the day of charge.\n",
                "items" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "maximum" : 4000,
                  "minimum" : 1,
                  "example" : null
                },
                "example" : null
              },
              "on_event" : {
                "type" : "array",
                "description" : "Event on which this addon will be charged.\n",
                "items" : {
                  "type" : "string",
                  "deprecated" : false,
                  "enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ],
                  "example" : null
                },
                "example" : null
              },
              "charge_once" : {
                "type" : "array",
                "description" : "If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.\n",
                "items" : {
                  "type" : "boolean",
                  "default" : true,
                  "deprecated" : false,
                  "example" : null
                },
                "example" : null
              },
              "charge_on" : {
                "type" : "array",
                "description" : "Indicates when the non-recurring addon will be charged.\n",
                "items" : {
                  "type" : "string",
                  "deprecated" : false,
                  "enum" : [ "immediately", "on_event" ],
                  "example" : null
                },
                "example" : null
              }
            },
            "example" : null
          }
        }, {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "customer-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/customer-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "estimate" : {
                      "$ref" : "#/components/schemas/Estimate",
                      "description" : "Resource object representing estimate\n"
                    }
                  },
                  "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.\n\nIn the response,\n\n* **estimate.subscription_estimate** has the subscription details like the status of the subscription (in_trial, active, etc.), next billing date, and so on.\n* **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\n  * *prorate* parameter is false, or\n  * *invoice_immediately* parameter is false, or\n  * subscription is in *in-trial* state\n* **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.\n* **estimate.unbilled_charge_estimates\\[\\]** has details of the unbilled charges. This is returned only if *invoice_immediately* is set as false.\n",
        "operationId" : "subscription_change_term_end_estimate",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "subscription-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/subscription-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "term_ends_at" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "The time at which the current term should end for this subscription.\n",
                    "example" : null
                  },
                  "prorate" : {
                    "type" : "boolean",
                    "deprecated" : false,
                    "description" : "Applicable for *active*\n/ *non_renewing*\nsubscriptions. If specified as *true*\nprorated charges / credits will be added during this operation.\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).\nThe 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\n"
                    }
                  },
                  "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.\n\nIn the response,\n\n* **estimate.subscription_estimate** has the subscription details.\n* **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.\n* **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.\n",
        "operationId" : "pause_subscription_estimate",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "subscription-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/subscription-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "pause_option" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "List of options to pause the subscription.\n\n* 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/subscriptions/pause-a-subscription#skip_billing_cycles)\n* immediately - Pause immediately\n* end_of_term - Pause at the end of current term\n* specific_date - Pause on a specific date\n",
                    "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`.\n\n* invoice -\n  Invoice charges\n  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.\n* no_action -\n  Retain as unbilled\n  If `no_action` is chosen, charges are added to the resumption invoice.\n",
                    "enum" : [ "no_action", "invoice" ],
                    "example" : null
                  },
                  "subscription" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for subscription\n",
                    "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`\nstate, it is the date/time when the subscription was paused.\n",
                        "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.\n",
                        "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.\n",
                        "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\n"
                    }
                  },
                  "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.\n",
        "operationId" : "advance_invoice_estimate",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "subscription-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/subscription-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "terms_to_charge" : {
                    "type" : "integer",
                    "format" : "int32",
                    "default" : 1,
                    "deprecated" : false,
                    "description" : "* 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`.\n* 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. .\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).\nApplicable only when [`schedule_type`](/docs/api/subscriptions/charge-future-renewals#schedule_type)\nis `immediate`\n.\n",
                    "example" : null
                  },
                  "schedule_type" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The type of advance invoice or advance invoicing schedule.\n\n* immediate -\n  Charge immediately for the number of billing cycles specified by [`terms_to_charge`](/docs/api/subscriptions/charge-future-renewals#terms_to_charge)\n  .\n* specific_dates -\n  Charge on [specific dates](/docs/api/subscriptions/charge-future-renewals#specific_dates_schedule_date).\n  For each date, specify the [number of billing cycles](/docs/api/subscriptions/charge-future-renewals#specific_dates_schedule_terms_to_charge)\n  to charge for. Up to 5 dates can be configured.\n* fixed_intervals -\n  Charge at fixed intervals of time. Specify the [number of billing cycles](/docs/api/subscriptions/charge-future-renewals#terms_to_charge)\n  that constitute an interval and the number of [days before each interval](/docs/api/subscriptions/charge-future-renewals#fixed_interval_schedule_days_before_renewal)\n  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)\n  .\n",
                    "enum" : [ "immediate", "specific_dates", "fixed_intervals" ],
                    "example" : null
                  },
                  "fixed_interval_schedule" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for fixed_interval_schedule\n",
                    "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)\nof 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)\n= `after_number_of_intervals`\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",
                        "minimum" : 1,
                        "example" : null
                      },
                      "end_schedule_on" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Specifies when the schedule should end.\n\n* after_number_of_intervals - Advance invoices are generated a `specified number of times`\n* subscription_end - Advance invoices are generated for as long as the subscription is active.\n* specific_date -\n  End the advance invoicing schedule on a `specific date`\n  .\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 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)\n= `specific_date`\n.\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "specific_dates_schedule" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for specific_dates_schedule\n",
                    "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)\nis specific_dates.\n",
                        "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)\nis `specific_dates`\n.\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" : {
                    "estimate" : {
                      "$ref" : "#/components/schemas/Estimate",
                      "description" : "Resource object representing estimate\n"
                    }
                  },
                  "required" : [ "estimate" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/estimates/create_subscription" : {
      "post" : {
        "tags" : [ "estimates" ],
        "summary" : "Create subscription estimate",
        "description" : "Generates an estimate for the 'create subscription' operation. This is similar to the [Create Subscription](/docs/api/v2/pcv-1/subscriptions/create-a-subscription) API but no subscription will be created, only an estimate for this operation is created.\n\nIn the response,\n\n* **estimate.subscription_estimate** has the subscription details like the status of the subscription (in_trial, active, etc.), next billing date, and so on.\n\n* **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.\n\n**estimate.next_invoice_estimate**\nhas details of the invoice that will be generated on the next billing date of this subscription. This will be present only if no immediate invoice is generated during this operation and this subscription has next billing.  \nIf the subscription is created in **trial/future**\nstates, *estimate.invoice_estimate*\nwill not be present as no immediate invoice would be generated. However, *estimate.next_invoice_estimate*\nwill be returned which is a preview of the invoice that would be generated at a later date when the subscription becomes 'active'.\n\n* **estimate.unbilled_charge_estimates** has details of the unbilled charges. This is returned only if *invoice_immediately* is set as false. But this is not applicable for the 'Subscription renewal estimate' operation.\n\n**Tip**\n\nSet the `customer[taxability]`\nattribute as `true`\nand provide any other necessary parameters to compute taxes. Otherwise tax is exempted for the estimate.\n\n#### Related Tutorial\n\n* [Check out this tutorial for when and how to use create subscription estimate API](https://www.chargebee.com/tutorials/in-app-checkout-page-using-estimate-api-example.html)\n",
        "operationId" : "create_subscription_estimate",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "billing_cycles" : {
                    "type" : "integer",
                    "format" : "int32",
                    "deprecated" : false,
                    "description" : "Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.\n",
                    "minimum" : 0,
                    "example" : null
                  },
                  "mandatory_addons_to_remove" : {
                    "type" : "array",
                    "deprecated" : false,
                    "description" : "List of addons IDs that are mandatory to the plan and has to be removed from the subscription.\n",
                    "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)\n.\n",
                    "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)\nfor Calendar Billing. Only applicable when using Calendar Billing. The default value is that which has been configured for the site.\n\n* immediate - Subscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..\n* delayed - Subscription period will be aligned with the configured billing date at the next renewal.\n",
                    "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.\n",
                    "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).\nThe 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.\n`taxes`\nand\n`line_item_taxes`\nare 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.\n",
                    "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)\nintegration.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "subscription" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for subscription\n",
                    "properties" : {
                      "id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "A unique and immutable identifier for the subscription. If not provided, it is autogenerated.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "plan_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Identifier of the plan for this subscription\n",
                        "maxLength" : 100,
                        "example" : null
                      },
                      "plan_quantity" : {
                        "type" : "integer",
                        "format" : "int32",
                        "default" : 1,
                        "deprecated" : false,
                        "description" : "Plan quantity for this subscription\n",
                        "minimum" : 1,
                        "example" : null
                      },
                      "plan_quantity_in_decimal" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "maxLength" : 33,
                        "example" : null
                      },
                      "plan_unit_price" : {
                        "type" : "integer",
                        "format" : "int64",
                        "deprecated" : false,
                        "description" : "Amount that will override the Plan's default price. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                        "minimum" : 0,
                        "example" : null
                      },
                      "plan_unit_price_in_decimal" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "When [price overriding](http://chargebee.com/docs/price-override.html )\nis enabled for the site, the price or per-unit price of the plan can be set here. The value [set for the plan](/docs/api/v2/pcv-1/plans/plan-object#price)\nis used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "maxLength" : 39,
                        "example" : null
                      },
                      "setup_fee" : {
                        "type" : "integer",
                        "format" : "int64",
                        "deprecated" : false,
                        "description" : "Amount that will override the default setup fee. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                        "minimum" : 0,
                        "example" : null
                      },
                      "trial_end" : {
                        "type" : "integer",
                        "format" : "unix-time",
                        "deprecated" : false,
                        "description" : "The time at which the trial ends for this subscription. Can be specified to override the default trial period.If **'0'**\nis passed, the subscription will be activated immediately.\n",
                        "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:\n\n* Backdating is enabled for subscription creation operations.\n* 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.\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, `start_date` cannot be earlier than 14th February.\n",
                        "example" : null
                      },
                      "offline_payment_method" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The preferred offline payment method for the subscription.\n\n* uk_automated_bank_transfer - UK Automated Bank Transfer\n* jp_automated_bank_transfer - JP Automated Bank Transfer\n* bank_transfer - Bank Transfer\n* us_automated_bank_transfer - US Automated Bank Transfer\n* boleto - Boleto\n* no_preference - No Preference\n* sepa_credit - SEPA Credit\n* mx_automated_bank_transfer - MX Automated Bank Transfer\n* ach_credit - ACH Credit\n* custom - Custom\n* eu_automated_bank_transfer - EU Automated Bank Transfer\n* cash - Cash\n* check - Check\n",
                        "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.\n",
                        "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)\nattribute of the [plan](/docs/api/v2/pcv-1/subscriptions/create-a-subscription#plan_id)\nchosen.\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
                      },
                      "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`\nor a custom value depending on the [site configuration](https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms)\n.\n",
                        "maximum" : 100,
                        "minimum" : 1,
                        "example" : null
                      },
                      "trial_end_action" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Applicable only when [End-of-trial Action](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)\nhas 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.\n\n* activate_subscription - The subscription activates and charges are raised for non-metered items.\n* cancel_subscription - The subscription cancels.\n* plan_default -\n  The action [configured for the site](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)\n  at the time when the trial ends, takes effect.\n* site_default -\n  This is the default value. The action [configured for the site](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)\n  at the time when the trial ends, takes effect.\n",
                        "enum" : [ "site_default", "plan_default", "activate_subscription", "cancel_subscription" ],
                        "example" : null
                      }
                    },
                    "required" : [ "plan_id" ],
                    "example" : null
                  },
                  "billing_address" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for billing_address\n",
                    "properties" : {
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line3" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 3\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n).\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.\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://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.\n\n* valid - Address was validated successfully.\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n",
                        "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "shipping_address" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for shipping_address\n",
                    "properties" : {
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line3" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 3\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n).\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.\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://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.\n\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n* valid - Address was validated successfully.\n",
                        "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "customer" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for customer\n",
                    "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.\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).\nOnly applicable specifically for customers with [billing_address](/docs/api/customers/customer-object#billing_address)\n\n`country`\nas `XI`\n(which is **United Kingdom - Northern Ireland**\n).\n\nWhen you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\nin 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\nthe Brexit configuration, you have the option of setting [billing_address](/docs/api/customers/customer-object#billing_address)\n\n`country`\nas `XI`.\nThat's the code for **United Kingdom - Northern Ireland** .\nThe first two characters of the VAT number in such a case is\n`XI`\nby default. However, if the VAT number was registered in UK, the value should be `GB`.\nSet\n`vat_number_prefix`\nto `GB`\nfor such cases.\n",
                        "maxLength" : 10,
                        "example" : null
                      },
                      "registered_for_gst" : {
                        "type" : "boolean",
                        "deprecated" : false,
                        "description" : "Confirms that a customer is registered under GST. If set to `true`\nthen the [Reverse Charge Mechanism](https://www.chargebee.com/docs/australian-gst.html#reverse-charge-mechanism)\nis applicable. This field is applicable only when Australian GST is configured for your site.\n",
                        "example" : null
                      },
                      "taxability" : {
                        "type" : "string",
                        "default" : "taxable",
                        "deprecated" : false,
                        "description" : "Specifies if the customer is liable for tax\n\n* exempt -\n  * 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.\n  * 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.\n* 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.\n* taxable -\n  Computes tax for the customer based on the [site configuration](https://www.chargebee.com/docs/tax.html).\n  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.\n",
                        "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)\n.\n\n* med2 - US Medical Device Excise Tax with taxable sales tax\n* med1 - US Medical Device Excise Tax with exempt sales tax\n* b - State government\n* c - Tribe/Status Indian/Indian Band\n* a - Federal government\n* f - Religious organization\n* g - Resale\n* d - Foreign diplomat\n* e - Charitable or benevolent organization\n* j - Direct pay permit\n* k - Direct mail\n* h - Commercial agricultural production\n* i - Industrial production/manufacturer\n* n - Local government\n* l - Other or custom\n* m - Educational organization\n* r - Non-resident\n* p - Commercial aquaculture\n* q - Commercial Fishery\n",
                        "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)\n.\n",
                        "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)\nintegration.\nTo 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/)\n.\n",
                        "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)\nintegration.\n\n* business - When the purchase is made at a place of business\n* residential - When the purchase is made by a customer for home use\n* industrial - When the purchase is made by an industrial business\n* 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\n",
                        "enum" : [ "residential", "business", "senior_citizen", "industrial" ],
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "contract_term" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for contract_term\n",
                    "properties" : {
                      "action_at_term_end" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Action to be taken when the contract term completes.\n\n* evergreen - Contract term completes and the subscription renews.\n* renew -\n  * 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).\n  * 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`](/docs/api/contract_terms/contract_term-object#contract_end)\n, 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.\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "Identifier of the addon. Multiple addons can be passed.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "default" : 1,
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_in_decimal" : {
                        "type" : "array",
                        "description" : "The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis 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 addon. The value depends on the [type of currency](/docs/api/getting-started).  \n**Note:**\n\nFor recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the [addon period](/docs/api/v2/pcv-1/addons/addon-object#period). For example, consider the following details:\n\n* The `unit_price` provided is $10\n* The addon billing period is 1 month.\n* The plan billing period is 3 months.\n* The addon is only billed for $10 on each subscription renewal.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price_in_decimal" : {
                        "type" : "array",
                        "description" : "When [price overriding](http://chargebee.com/docs/price-override.html )\nis enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)\nis used by default. However, the price provided here is considered as the price of the addon for an entire billing cycle of the subscription regardless of the value of the addon `period`.\nProvide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      },
                      "billing_cycles" : {
                        "type" : "array",
                        "description" : "Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "trial_end" : {
                        "type" : "array",
                        "description" : "The time at which the trial ends for the addon. This value can only be set for subscriptions that start with an `active`\nor `non-renewing`\nstatus. Once set, the value can't be changed. (Addon trial periods must be enabled by [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",
                        "items" : {
                          "type" : "integer",
                          "format" : "unix-time",
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "event_based_addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for event_based_addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "A unique 'id' used to identify the addon.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price" : {
                        "type" : "array",
                        "description" : "Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_in_decimal" : {
                        "type" : "array",
                        "description" : "The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 33,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price_in_decimal" : {
                        "type" : "array",
                        "description" : "When [price overriding](http://chargebee.com/docs/price-override.html )\nis enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)\nis used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      },
                      "service_period_in_days" : {
                        "type" : "array",
                        "description" : "Defines service period of the addon in days from the day of charge.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "maximum" : 4000,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "on_event" : {
                        "type" : "array",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "description" : "Event on which this addon will be charged.\n\n* plan_activation - Addon will be charged on plan activation.\n* contract_termination - Addon will be charged on contract termination.\n* subscription_activation - Addon will be charged on subscription activation.\n* subscription_creation - Addon will be charged on subscription creation.\n* subscription_trial_start - Addon will be charged when the trial period starts.\n",
                          "enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ],
                          "example" : null
                        },
                        "example" : null
                      },
                      "charge_once" : {
                        "type" : "array",
                        "description" : "If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.\n",
                        "items" : {
                          "type" : "boolean",
                          "default" : true,
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      },
                      "charge_on" : {
                        "type" : "array",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "description" : "Indicates when the non-recurring addon will be charged.\n\n* immediately - Charges for the addon will be applied immediately.\n* on_event - Charge for the addon will be applied on the occurrence of a specified event.\n",
                          "enum" : [ "immediately", "on_event" ],
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "tax_providers_fields" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for tax_providers_fields\n",
                    "properties" : {
                      "provider_name" : {
                        "type" : "array",
                        "description" : "Name of the tax provider.\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",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "field_value" : {
                        "type" : "array",
                        "description" : "The value of the related tax field\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  }
                },
                "example" : null
              },
              "encoding" : {
                "addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "billing_address" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "contract_term" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "customer" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "event_based_addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "shipping_address" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "subscription" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "tax_providers_fields" : {
                  "style" : "deepObject",
                  "explode" : true
                }
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "estimate" : {
                      "$ref" : "#/components/schemas/Estimate",
                      "description" : "Resource object representing estimate\n"
                    }
                  },
                  "required" : [ "estimate" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/estimates/create_invoice" : {
      "post" : {
        "tags" : [ "estimates" ],
        "summary" : "Create invoice estimate",
        "description" : "Generates an estimate for the 'create an invoice' operation. This is similar to the [Create an invoice](/docs/api/v2/pcv-1/invoices/create-an-invoice) API, but the invoice will not be generated. Only an estimate for this operation is created.\n\nIn the response,\n\n* **estimate.invoice_estimate** has details of the invoice that will be generated immediately.\n",
        "operationId" : "create_invoice_estimate",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "currency_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The currency code (ISO 4217 format) of the invoice amount.\n",
                    "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)\nfor the invoice are displayed on the PDF invoice sent to the customer.\n",
                    "maxLength" : 2000,
                    "example" : null
                  },
                  "remove_general_note" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "Set as `true`\nto remove the [**general note**](https://www.chargebee.com/docs/invoice_notes.html#adding-general-notes)\nfrom this invoice.\n",
                    "example" : null
                  },
                  "coupon_ids" : {
                    "type" : "array",
                    "deprecated" : false,
                    "description" : "List of Coupons to be added.\n",
                    "items" : {
                      "type" : "string",
                      "deprecated" : false,
                      "maxLength" : 100,
                      "example" : null
                    },
                    "example" : null
                  },
                  "authorization_transaction_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Authorization transaction to be captured.\n",
                    "maxLength" : 40,
                    "example" : null
                  },
                  "payment_source_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Payment source to be used for this payment.\n",
                    "maxLength" : 40,
                    "example" : null
                  },
                  "auto_collection" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The customer level auto collection will be override if specified.\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
                  },
                  "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.\n`taxes`\nand\n`line_item_taxes`\nare 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.\n",
                    "example" : null
                  },
                  "invoice" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for invoice\n",
                    "properties" : {
                      "customer_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Identifier of the customer for which this invoice needs to be created. Should be specified if 'subscription_id' is not specified.\n",
                        "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)\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "po_number" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Purchase Order Number for this invoice.\n",
                        "maxLength" : 100,
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "shipping_address" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for shipping_address\n",
                    "properties" : {
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The first name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The last name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "The email address.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "company" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The company name.\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The phone number.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line3" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 3\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n).\n",
                        "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`\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.\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://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.\n\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n* valid - Address was validated successfully.\n",
                        "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "Identifier of the addon. Multiple addons can be passed.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "default" : 1,
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_in_decimal" : {
                        "type" : "array",
                        "description" : "The decimal representation of the quantity of the addon. Returned for quantity-based plans when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis 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 addon. The value depends on the [type of currency](/docs/api/getting-started).  \n**Note:**\n\nFor recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the [addon period](/docs/api/v2/pcv-1/addons/addon-object#period). For example, consider the following details:\n\n* The `unit_price` provided is $10\n* The addon billing period is 1 month.\n* The plan billing period is 3 months.\n* The addon is only billed for $10 on each subscription renewal.\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 addon. The value is in major units of the currency. Always returned when multi-decimal pricing is enabled.  \n**Note:**\n\nFor recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:\n\n* The `unit_price_in_decimal` provided is $10.75\n* The addon billing period is 1 month.\n* The plan billing period is 3 months.\n* The addon is only billed for $10.75 on each subscription renewal.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      },
                      "date_from" : {
                        "type" : "array",
                        "description" : "The time when the service period for the addon starts.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "unix-time",
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      },
                      "date_to" : {
                        "type" : "array",
                        "description" : "The time when the service period for the addon ends.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "unix-time",
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "charges" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for charges\n",
                    "properties" : {
                      "amount" : {
                        "type" : "array",
                        "description" : "The amount to be charged. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                        "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 ).\nProvide the value in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      },
                      "description" : {
                        "type" : "array",
                        "description" : "Description for this charge\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 250,
                          "example" : null
                        },
                        "example" : null
                      },
                      "taxable" : {
                        "type" : "array",
                        "description" : "The amount to be charged is taxable or not.\n",
                        "items" : {
                          "type" : "boolean",
                          "default" : true,
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      },
                      "tax_profile_id" : {
                        "type" : "array",
                        "description" : "Tax profile of the charge.\n",
                        "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)\n.\n",
                        "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)\nto which the item is mapped for calculating the customer's tax in India. Applicable only when both of the following conditions are true:\n\n* [**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.)\n* The [**AvaTax for Sales** integration](https://www.chargebee.com/docs/avalara.html) has been enabled in Chargebee.\n",
                        "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)\n.\n",
                        "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)\nintegration.\n\n* consumed - Transaction is for an item that is consumed directly\n* vendor_use - Transaction is for an item that is subject to vendor use tax\n* wholesale - Transaction is a sale to another company that will resell your product or service to another consumer\n* retail - Transaction is a sale to an end user\n",
                          "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)\nintegration.\n",
                        "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)\nintegration.\n",
                        "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.\n",
                        "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.\n",
                        "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\n",
                    "properties" : {
                      "entity_type" : {
                        "type" : "array",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "description" : "Type of entity to which the [note](/docs/api/invoices/invoice-object#notes)\nbelongs. To remove the general note, use the `remove_general_note`\nparameter.\n\n* plan - Entity that represents a plan.\n* addon - Entity that represents an addon.\n* customer - Entity that represents a customer.\n* subscription - Entity that represents a subscription of customer.\n* coupon - Entity that represents a coupon.\n",
                          "enum" : [ "plan", "addon", "customer", "subscription", "coupon" ],
                          "example" : null
                        },
                        "example" : null
                      },
                      "entity_id" : {
                        "type" : "array",
                        "description" : "Unique identifier of the [note](/docs/api/invoices/invoice-object#notes)\n.\n",
                        "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\n",
                    "properties" : {
                      "provider_name" : {
                        "type" : "array",
                        "description" : "Name of the tax provider.\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",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "field_value" : {
                        "type" : "array",
                        "description" : "The value of the related tax field\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  }
                },
                "example" : null
              },
              "encoding" : {
                "addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "charges" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "invoice" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "notes_to_remove" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "shipping_address" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "tax_providers_fields" : {
                  "style" : "deepObject",
                  "explode" : true
                }
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "estimate" : {
                      "$ref" : "#/components/schemas/Estimate",
                      "description" : "Resource object representing estimate\n"
                    }
                  },
                  "required" : [ "estimate" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/subscriptions/{subscription-id}/cancel_subscription_estimate" : {
      "post" : {
        "tags" : [ "subscriptions" ],
        "summary" : "Cancel subscription estimate",
        "description" : "Generates an estimate for the 'cancel subscription' operation. This is similar to the [Cancel a subscription](/docs/api/v2/pcv-1/subscriptions/cancel-a-subscription) API, but the subscription will not be cancelled. Only an estimate for this operation is created.\n\nIn the response,\n\n* **estimate.subscription_estimate** has the subscription details.\n* **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.\n* **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.\n* **estimate.unbilled_charge_estimates** has details of the unbilled charges.\n",
        "operationId" : "cancel_subscription_estimate",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "subscription-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/subscription-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "cancel_option" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "##### If the subscription does not have a contract term:\n\nDetermines when to cancel the subscription.\n\n##### If the subscription has a contract term:\n\nThis parameter is not applicable.\n\n* 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\n* end_of_term - This is used to cancel a subscription at the end of the current billing cycle\n* immediately - This is used to cancel the subscription with immediate effect\n* 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`\n",
                    "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.\nApplicable only when the subscription does not have [contract terms](/docs/api/contract_terms).\nSet 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`.\n",
                    "example" : null
                  },
                  "cancel_at" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "##### If the subscription does not have a contract term:\n\nSpecifies the date and time when the subscription should be canceled. Do not use this parameter when `end_of_term` is set to `true`.\n\n##### If the subscription has a contract term:\n\nApplicable only when `contract_term_cancel_option` is `specific_date`. Specifies the date and time to cancel the subscription and contract term.\n\n##### Backdating\n\nYou can set a past date to backdate the cancellation. Backdating is allowed only if the following conditions are met:\n\n* [Backdating](https://www.chargebee.com/docs/1.0/backdating.html) is enabled for subscription cancellation.\n* The current date does not exceed the [backdating limit configured in Chargebee Billing](https://www.chargebee.com/docs/1.0/backdating.html#configuring-backdated-subscription-actions-and-invoicing).\n* The date is on or after the `current_term_start`.\n* The date is on or after the most recent change involving:\n  * Addition/change/removal of plan or addon item prices.\n  * Addition of charge item prices.\n* 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.\n",
                    "example" : null
                  },
                  "credit_option_for_current_term_charges" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "##### If the subscription does not have a contract term:\n\nSpecifies 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/1.0/cancellations.html#configure-subscription-cancellation) is used.\n\n##### If the subscription has a contract term:\n\nSpecifies 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/1.0/contract-terms.html#configuring-contract-terms) is used.\n\n* none - No credits notes are created.\n* full - Credits are issues for the full value of the current term charges.\n* prorate - Prorated credits are issued.\n",
                    "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:\n\nSpecifies 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/1.0/cancellations.html#configure-subscription-cancellation) is used.\n\n##### If the subscription has a contract term:\n\nSpecifies 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/1.0/contract-terms.html#configuring-contract-terms) is used.\n\n* invoice - An invoice is generated immediately with the unbilled charges.\n* delete - The unbilled charges are deleted.\n",
                    "enum" : [ "invoice", "delete" ],
                    "example" : null
                  },
                  "account_receivables_handling" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "##### If the subscription does not have a contract term:\n\nSpecifies 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/1.0/cancellations.html#configure-subscription-cancellation) is used.\n\n##### If the subscription has a contract term:\n\nSpecifies 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/1.0/contract-terms.html#configuring-contract-terms) is used.\n\n* no_action - No action is taken.\n* write_off -\n  Applies excess payments and refundable credits to past due invoices. Any remaining balance is written off.\n\n  *Note: The credit note for the write-off is not included in the API response.*\n* schedule_payment_collection -\n  Applies excess payments and refundable credits to past due invoices. If any amount remains and `auto_collection`\n  is `on`\n  , the remaining amount is automatically charged to the available payment method.\n",
                    "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:\n\nSpecifies 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/1.0/cancellations.html#configure-subscription-cancellation) is used.\n\n##### If the subscription has a contract term:\n\nSpecifies 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/1.0/contract-terms.html#configuring-contract-terms) is used.\n\n* schedule_refund - Refunds remaining credits after applying them to any past due invoices.\n* no_action - No action is taken.\n",
                    "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.\n\n* terminate_immediately -\n  Cancels the subscription and contract term immediately. Sets the contract term's `status` to `terminated` and collects any termination fee, if applicable.\n\n  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).\n* end_of_contract_term - Prevents the contract term from renewing and schedules the subscription for cancellation at the end of the contract term.\n* specific_date -\n  Cancels the subscription and contract term on the date specified by `cancel_at`. Sets `action_at_term_end` to `cancel`.\n\n  **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/1.0/sites-intro.html).\n* end_of_subscription_billing_term -\n  Cancels the subscription and contract term at the end of the current billing cycle. Sets `action_at_term_end` to `cancel`.\n\n  **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/1.0/sites-intro.html).\n",
                    "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`\nis `true`\n, 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`\nand `line_item_taxes`\nare computed based on the `tax`\nconfiguration as of `invoice_date`.\nWhen passing this parameter, the following prerequisites must be met:\n\n* `invoice_date` must be in the past.\n* `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.\n* It is not earlier than `cancel_at`. .\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**.\nMust be passed if set as mandatory in the app. The codes are case-sensitive.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "event_based_addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for event_based_addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "The unique `id`\nof the event-based addon that represents the termination fee.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "The quantity associated with the termination fee. Applicable only when the addon for the termination charge is quantity-based.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price" : {
                        "type" : "array",
                        "description" : "The termination fee. In case it is quantity-based, this is the fee per unit.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "service_period_in_days" : {
                        "type" : "array",
                        "description" : "The service period of the termination fee-expressed in days-starting from the current date.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "maximum" : 4000,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  }
                },
                "example" : null
              },
              "encoding" : {
                "event_based_addons" : {
                  "style" : "deepObject",
                  "explode" : true
                }
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "estimate" : {
                      "$ref" : "#/components/schemas/Estimate",
                      "description" : "Resource object representing estimate\n"
                    }
                  },
                  "required" : [ "estimate" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/quotes/{quote-id}/edit_one_time_quote" : {
      "post" : {
        "tags" : [ "quotes" ],
        "summary" : "Edit quote for one-time charges",
        "description" : "Edits a quote. The quote must be for [one-time charges](https://www.chargebee.com/docs/charges.html#one-time-charges) or [non-recurring addons](https://www.chargebee.com/docs/charges.html#non-recurring-addon).\n\nTo edit quotes created for subscriptions, use:\n\n* [​​Edit quote for new subscription](/docs/api/v2/pcv-1/quotes/edit-quote-for-a-new-subscription).\n* [Edit quote for updating a subscription](/docs/api/v2/pcv-1/quotes/edit-quote-for-updating-a-subscription).\n",
        "operationId" : "edit_quote_for_one-time_charges",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "quote-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/quote-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "po_number" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Purchase Order Number for this quote.\n",
                    "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.\n",
                    "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.\n",
                    "example" : null
                  },
                  "currency_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The currency code (ISO 4217 format) of the quote.\n",
                    "maxLength" : 3,
                    "example" : null
                  },
                  "coupon" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The 'One Time' coupon to be applied.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "coupon_ids" : {
                    "type" : "array",
                    "deprecated" : false,
                    "description" : "List of Coupons to be added.\n",
                    "items" : {
                      "type" : "string",
                      "deprecated" : false,
                      "maxLength" : 100,
                      "example" : null
                    },
                    "example" : null
                  },
                  "shipping_address" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for shipping_address\n",
                    "properties" : {
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The first name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The last name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "The email address.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "company" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The company name.\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The phone number.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line3" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 3\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "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`\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.\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://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.\n\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n* valid - Address was validated successfully.\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n",
                        "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "Identifier of the addon. Multiple addons can be passed.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "default" : 1,
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_in_decimal" : {
                        "type" : "array",
                        "description" : "The decimal representation of the quantity of the addon. Returned for quantity-based plans when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis 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 addon. The value depends on the [type of currency](/docs/api/getting-started).  \n**Note:**\n\nFor recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the [addon period](/docs/api/v2/pcv-1/addons/addon-object#period). For example, consider the following details:\n\n* The `unit_price` provided is $10\n* The addon billing period is 1 month.\n* The plan billing period is 3 months.\n* The addon is only billed for $10 on each subscription renewal.\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 addon. The value is in major units of the currency. Always returned when multi-decimal pricing is enabled.  \n**Note:**\n\nFor recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:\n\n* The `unit_price_in_decimal` provided is $10.75\n* The addon billing period is 1 month.\n* The plan billing period is 3 months.\n* The addon is only billed for $10.75 on each subscription renewal.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      },
                      "service_period" : {
                        "type" : "array",
                        "description" : "Specifies the service period of the addon in days. When the quote is converted, the [invoice.line_item.date_from](/docs/api/invoices/invoice-object#line_items)\nis set to current date/time and [invoice.line_item.date_to](/docs/api/invoices/invoice-object#line_items)\nis set to `service_period`\ndays ahead of [date_from](/docs/api/invoices/invoice-object#line_items)\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "charges" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for charges\n",
                    "properties" : {
                      "amount" : {
                        "type" : "array",
                        "description" : "The amount to be charged. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                        "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).\nApplicable only when multi-decimal pricing is enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      },
                      "description" : {
                        "type" : "array",
                        "description" : "Description for this charge\n",
                        "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)\nintegration.\n\n* wholesale - Transaction is a sale to another company that will resell your product or service to another consumer\n* retail - Transaction is a sale to an end user\n* consumed - Transaction is for an item that is consumed directly\n* vendor_use - Transaction is for an item that is subject to vendor use tax\n",
                          "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)\nintegration.\n",
                        "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)\nintegration.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      },
                      "service_period" : {
                        "type" : "array",
                        "description" : "Service period for charge\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "tax_providers_fields" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for tax_providers_fields\n",
                    "properties" : {
                      "provider_name" : {
                        "type" : "array",
                        "description" : "Name of the tax provider currently supported.\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 us.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "field_value" : {
                        "type" : "array",
                        "description" : "The value of the corresponding tax field.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  }
                },
                "example" : null
              },
              "encoding" : {
                "addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "charges" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "shipping_address" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "tax_providers_fields" : {
                  "style" : "deepObject",
                  "explode" : true
                }
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "quote" : {
                      "$ref" : "#/components/schemas/Quote",
                      "description" : "Resource object representing quote\n"
                    },
                    "quoted_charge" : {
                      "$ref" : "#/components/schemas/QuotedCharge",
                      "description" : "Resource object representing quoted_charge\n"
                    }
                  },
                  "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" : "**Important**\n\nFor sites where both [legacy and latest](/docs/api/v2/pcv-1/upgrade#retrieving-api-responses-in-latest-api-format) product catalog versions are active, GET API requests return responses in a `compat` format by default. This format works with both latest and legacy Product Catalog.\n\n**Override options:**\n\n* `chargebee-response-schema-type: items` → Return response in latest product catalog format only.\n* `chargebee-response-schema-type: plans_addons` → Return response in legacy product catalog format only.\n\nRetrieves the quotes identified by the \\`number\\` specified in the URL.\n",
        "operationId" : "retrieve_a_quote",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "quote-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/quote-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "quote" : {
                      "$ref" : "#/components/schemas/Quote",
                      "description" : "Resource object representing quote\n"
                    },
                    "quoted_subscription" : {
                      "$ref" : "#/components/schemas/QuotedSubscription",
                      "description" : "Resource object representing quoted_subscription\n"
                    },
                    "quoted_charge" : {
                      "$ref" : "#/components/schemas/QuotedCharge",
                      "description" : "Resource object representing quoted_charge\n"
                    },
                    "quoted_ramp" : {
                      "$ref" : "#/components/schemas/QuotedRamp",
                      "description" : "Resource object representing quoted_ramp\n"
                    }
                  },
                  "required" : [ "quote" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/quotes/update_subscription_quote" : {
      "post" : {
        "tags" : [ "quotes" ],
        "summary" : "Create quote for updating a subscription",
        "description" : "Creates a quote for updating a subscription under the customer specified.\n\nTo send this quote, use \"[Send Email](https://www.chargebee.com/docs/quotes.html#other-quote-actions_send-email)\" quote action in the Chargebee application.\n\nBased on the customer's reply, you can use [Update quote status](/docs/api/v2/pcv-1/quotes/update-quote-status) and [Convert a quote](/docs/api/v2/pcv-1/quotes/convert-a-quote) APIs for changing quote status and invoicing the customer, respectively.\n",
        "operationId" : "create_quote_for_updating_a_subscription",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "name" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The quote name will be used as the pdf name of the quote.\n",
                    "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.\n",
                    "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.\n",
                    "example" : null
                  },
                  "replace_addon_list" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "Should be true if the existing addons should be replaced with the ones that are being passed.\n",
                    "example" : null
                  },
                  "mandatory_addons_to_remove" : {
                    "type" : "array",
                    "deprecated" : false,
                    "description" : "List of addons IDs that are mandatory to the plan and has to be removed from the subscription.\n",
                    "items" : {
                      "type" : "string",
                      "deprecated" : false,
                      "maxLength" : 100,
                      "example" : null
                    },
                    "example" : null
                  },
                  "billing_cycles" : {
                    "type" : "integer",
                    "format" : "int32",
                    "deprecated" : false,
                    "description" : "The number of billing cycles the subscription runs before canceling. If not provided, then the billing cycles set for the plan is used.\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).\nIf a new term is started for the subscription due to this API call, then `terms_to_charge`\nis inclusive of this new term. See description for the `force_term_reset`\nparameter to learn more about when a subscription term is reset.\n",
                    "minimum" : 1,
                    "example" : null
                  },
                  "reactivate_from" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "If the subscription `status`\nis `cancelled`\nand it is being reactivated via this operation, this is the date/time at which the subscription should be reactivated.\n**Note:**\nIt is recommended not to pass this parameter along with `changed_scheduled_at`.\n`reactivate_from`\ncan 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:\n\n* Backdating must be enabled for subscription reactivation operations.\n* 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.\n* The date is on or after the last date/time any of the product catalog items of the subscription were changed.\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
                  },
                  "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)\nchosen for the site for calendar billing. Only applicable when using calendar billing.\n\n* immediate - Subscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..\n* delayed - Subscription period will be aligned with the configured billing date at the next renewal.\n",
                    "enum" : [ "immediate", "delayed" ],
                    "example" : null
                  },
                  "coupon_ids" : {
                    "type" : "array",
                    "deprecated" : false,
                    "description" : "Identifier of the coupon as a List. Coupon Codes can also be passed.\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.\n",
                    "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.\n\n* specific_date -\n  The change is carried out as of the date specified under `changes_scheduled_at`\n  .\n* immediately - The change is carried out immediately.\n",
                    "enum" : [ "immediately", "specific_date" ],
                    "example" : null
                  },
                  "changes_scheduled_at" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "When `change_option`\nis set to `specific_date`\n, then set the date/time at which the subscription change is to happen or has happened. `changes_scheduled_at`\ncan 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\n* Only the following changes can be backdated:\n\n* Changes in the recurring items or their prices.\n\n* Addition of non-recurring items.\n\n* Subscription `status` is `active`, `cancelled`, or `non_renewing`.\n\n* 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.\n\n* The date is on or after `current_term_start`.\n\n* The date is on or after the last date/time any of the following changes were made:\n\n* Changes in the recurring items or their prices.\n\n* Addition of non-recurring items.\n\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 subscription's plan is 2 months and today is 14th April, `changes_scheduled_at` cannot be earlier than 14th February..\n\n**Note:**\nThe `changes_scheduled_at`\nparameter does not apply to `auto_collection`\n, `shipping_address`\n, and `po_number`\n; these parameters take effect **immediately**\nwhen scheduling a subscription update.\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'.\n**Note**:\nSpecifying this value as 'false' has no impact on the default behaviour.\n",
                    "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.\n",
                    "example" : null
                  },
                  "subscription" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for subscription\n",
                    "properties" : {
                      "id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "A unique and immutable identifier for the subscription. If not provided, it is autogenerated.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "plan_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Identifier of the plan for this subscription\n",
                        "maxLength" : 100,
                        "example" : null
                      },
                      "plan_quantity" : {
                        "type" : "integer",
                        "format" : "int32",
                        "default" : 1,
                        "deprecated" : false,
                        "description" : "Represents the plan quantity for this subscription.\n",
                        "minimum" : 1,
                        "example" : null
                      },
                      "plan_unit_price" : {
                        "type" : "integer",
                        "format" : "int64",
                        "deprecated" : false,
                        "description" : "Amount that will override the Plan's default price. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                        "minimum" : 0,
                        "example" : null
                      },
                      "setup_fee" : {
                        "type" : "integer",
                        "format" : "int64",
                        "deprecated" : false,
                        "description" : "Amount that will override the default setup fee. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                        "minimum" : 0,
                        "example" : null
                      },
                      "plan_quantity_in_decimal" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "maxLength" : 33,
                        "example" : null
                      },
                      "plan_unit_price_in_decimal" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "When price overriding is enabled for the site, the price or per-unit price of the plan can be set here. The value [set for the plan](/docs/api/v2/pcv-1/plans/plan-object#price)\nis used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "maxLength" : 39,
                        "example" : null
                      },
                      "start_date" : {
                        "type" : "integer",
                        "format" : "unix-time",
                        "deprecated" : false,
                        "description" : "The new start date of a `future`\nsubscription. Applicable only for `future`\nsubscriptions.\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. This is only allowed when the subscription `status`\nis `future`\n, `in_trial`\n, or `cancelled`.\nAlso, the value must not be earlier than `changes_scheduled_at`\nor `start_date`.\n**Note** :\nThis parameter can be backdated (set to a value in the past) only when the subscription is in `cancelled`\nor `in_trial`\n`status`.\nDo this to keep a record of when the trial ended in case it ended at some point in the past. When `trial_end`\nis backdated, the subscription immediately goes into `active`\nor `non_renewing`\nstatus.\n",
                        "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.\n\n* off - Automatic collection of charges will not be made for this subscription. Use this for offline payments.\n* on - Whenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.\n",
                        "enum" : [ "on", "off" ],
                        "example" : null
                      },
                      "offline_payment_method" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The preferred offline payment method for the subscription.\n\n* uk_automated_bank_transfer - UK Automated Bank Transfer\n* jp_automated_bank_transfer - JP Automated Bank Transfer\n* bank_transfer - Bank Transfer\n* us_automated_bank_transfer - US Automated Bank Transfer\n* boleto - Boleto\n* no_preference - No Preference\n* sepa_credit - SEPA Credit\n* mx_automated_bank_transfer - MX Automated Bank Transfer\n* ach_credit - ACH Credit\n* custom - Custom\n* eu_automated_bank_transfer - EU Automated Bank Transfer\n* cash - Cash\n* check - Check\n",
                        "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`\nor a custom value depending on the [site configuration](https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms)\n.\n",
                        "maximum" : 100,
                        "minimum" : 1,
                        "example" : null
                      }
                    },
                    "required" : [ "id" ],
                    "example" : null
                  },
                  "billing_address" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for billing_address\n",
                    "properties" : {
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The first name of the billing contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The last name of the billing contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "The email address.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "company" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The company name.\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The phone number.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line3" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 3\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "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`\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.\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://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.\n\n* valid - Address was validated successfully.\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n",
                        "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "shipping_address" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for shipping_address\n",
                    "properties" : {
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The first name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The last name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "The email address.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "company" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The company name.\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The phone number.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line3" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 3\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "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`\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.\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://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.\n\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n* valid - Address was validated successfully.\n",
                        "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "customer" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for customer\n",
                    "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.\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).\nOnly applicable specifically for customers with [billing_address](/docs/api/customers/customer-object#billing_address)\n\n`country`\nas `XI`\n(which is **United Kingdom - Northern Ireland**\n).\n\nWhen you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\nin 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\nthe Brexit configuration, you have the option of setting [billing_address](/docs/api/customers/customer-object#billing_address)\n\n`country`\nas `XI`.\nThat's the code for **United Kingdom - Northern Ireland** .\nThe first two characters of the VAT number in such a case is\n`XI`\nby default. However, if the VAT number was registered in UK, the value should be `GB`.\nSet\n`vat_number_prefix`\nto `GB`\nfor such cases.\n",
                        "maxLength" : 10,
                        "example" : null
                      },
                      "registered_for_gst" : {
                        "type" : "boolean",
                        "deprecated" : false,
                        "description" : "Confirms that a customer is registered under GST. If set to `true`\nthen the [Reverse Charge Mechanism](https://www.chargebee.com/docs/australian-gst.html#reverse-charge-mechanism)\nis applicable. This field is applicable only when Australian GST is configured for your site.\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "contract_term" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for contract_term\n",
                    "properties" : {
                      "action_at_term_end" : {
                        "type" : "string",
                        "default" : "renew",
                        "deprecated" : false,
                        "description" : "Action to be taken when the contract term completes.\n\n* evergreen - Contract term completes and the subscription renews.\n* renew -\n  * 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).\n  * The `action_at_term_end` for the new contract term is set to `renew`.\n* renew_once -\n  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).\n\n  * The `action_at_term_end` for the new contract term is set to `cancel`.\n* cancel - Contract term completes and subscription is canceled.\n",
                        "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)\n, 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.\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "Identifier of the addon. Multiple addons can be passed.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "default" : 1,
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price" : {
                        "type" : "array",
                        "description" : "The price or per-unit-price of the addon. The value depends on the [type of currency](/docs/api/getting-started).  \n**Note:**\n\nFor recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the [addon period](/docs/api/v2/pcv-1/addons/addon-object#period). For example, consider the following details:\n\n* The `unit_price` provided is $10\n* The addon billing period is 1 month.\n* The plan billing period is 3 months.\n* The addon is only billed for $10 on each subscription renewal.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "billing_cycles" : {
                        "type" : "array",
                        "description" : "Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_in_decimal" : {
                        "type" : "array",
                        "description" : "The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 33,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price_in_decimal" : {
                        "type" : "array",
                        "description" : "When [price overriding](http://chargebee.com/docs/price-override.html )\nis enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)\nis used by default. However, the price provided here is considered as the price of the addon for an entire billing cycle of the subscription regardless of the value of the addon `period`.\nProvide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      },
                      "trial_end" : {
                        "type" : "array",
                        "description" : "The time at which the trial ends for the addon. To update this value, redo the complete addon set using [`replace_addon_list`](/docs/api/v2/pcv-1/subscriptions/update-a-subscription#replace_addon_list).\n(Addon trial periods must be enabled by [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",
                        "items" : {
                          "type" : "integer",
                          "format" : "unix-time",
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "event_based_addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for event_based_addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "A unique 'id' used to identify the addon.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price" : {
                        "type" : "array",
                        "description" : "Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "service_period_in_days" : {
                        "type" : "array",
                        "description" : "Defines service period of the addon in days from the day of charge.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "maximum" : 4000,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "charge_on" : {
                        "type" : "array",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "description" : "Indicates when the non-recurring addon will be charged.\n\n* immediately - Charges for the addon will be applied immediately.\n* on_event - Charge for the addon will be applied on the occurrence of a specified event.\n",
                          "enum" : [ "immediately", "on_event" ],
                          "example" : null
                        },
                        "example" : null
                      },
                      "on_event" : {
                        "type" : "array",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "description" : "Event on which this addon will be charged.\n\n* plan_activation - Addon will be charged on plan activation.\n* contract_termination - Addon will be charged on contract termination.\n* subscription_activation - Addon will be charged on subscription activation.\n* subscription_creation - Addon will be charged on subscription creation.\n* subscription_trial_start - Addon will be charged when the trial period starts.\n",
                          "enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ],
                          "example" : null
                        },
                        "example" : null
                      },
                      "charge_once" : {
                        "type" : "array",
                        "description" : "If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.\n",
                        "items" : {
                          "type" : "boolean",
                          "default" : true,
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_in_decimal" : {
                        "type" : "array",
                        "description" : "The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 33,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price_in_decimal" : {
                        "type" : "array",
                        "description" : "When [price overriding](http://chargebee.com/docs/price-override.html )\nis enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)\nis used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  }
                },
                "example" : null
              },
              "encoding" : {
                "addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "billing_address" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "contract_term" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "customer" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "event_based_addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "shipping_address" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "subscription" : {
                  "style" : "deepObject",
                  "explode" : true
                }
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "quote" : {
                      "$ref" : "#/components/schemas/Quote",
                      "description" : "Resource object representing quote\n"
                    },
                    "quoted_subscription" : {
                      "$ref" : "#/components/schemas/QuotedSubscription",
                      "description" : "Resource object representing quoted_subscription\n"
                    }
                  },
                  "required" : [ "quote" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/quotes/create_for_onetime_charges" : {
      "post" : {
        "tags" : [ "quotes" ],
        "summary" : "Create quote for one-time charges",
        "description" : "Creates a quote for [one-time charges](https://www.chargebee.com/docs/charges.html#one-time-charges) and [non-recurring addons](https://www.chargebee.com/docs/charges.html#non-recurring-addon). This is applicable only for one-time payment. Recurring charges are not permitted in this quote; use [Create quote for a new subscription](/docs/api/v2/pcv-1/quotes/create-quote-for-a-new-subscription) or [Create quote for updating a subscription](/docs/api/v2/pcv-1/quotes/create-quote-for-updating-a-subscription) instead.\n\nTo send this quote, use \"[Send Email](https://www.chargebee.com/docs/quotes.html#other-quote-actions_send-email)\" quote action in the Chargebee application.\n\nBased on the customer's reply, you can use [Update quote status](/docs/api/quotes/update-quote-status) and [Convert a quote](/docs/api/quotes/convert-a-quote) APIs for changing quote status and invoicing the customer, respectively.\n",
        "operationId" : "create_quote_for_one-time_charges",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "name" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The quote name will be used as the pdf name of the quote.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "customer_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Identifier of the customer for which the quote needs to be created.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "po_number" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Purchase Order Number for this quote.\n",
                    "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.\n",
                    "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.\n",
                    "example" : null
                  },
                  "currency_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The currency code (ISO 4217 format) of the quote.\n",
                    "maxLength" : 3,
                    "example" : null
                  },
                  "coupon" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The 'One Time' coupon to be applied.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "coupon_ids" : {
                    "type" : "array",
                    "deprecated" : false,
                    "description" : "List of Coupons to be added.\n",
                    "items" : {
                      "type" : "string",
                      "deprecated" : false,
                      "maxLength" : 100,
                      "example" : null
                    },
                    "example" : null
                  },
                  "shipping_address" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for shipping_address\n",
                    "properties" : {
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The first name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The last name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "The email address.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "company" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The company name.\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The phone number.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line3" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 3\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "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`\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.\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://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.\n\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n* valid - Address was validated successfully.\n",
                        "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "Identifier of the addon. Multiple addons can be passed.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "default" : 1,
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_in_decimal" : {
                        "type" : "array",
                        "description" : "The decimal representation of the quantity of the addon. Returned for quantity-based plans when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis 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 addon. The value depends on the [type of currency](/docs/api/getting-started).  \n**Note:**\n\nFor recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the [addon period](/docs/api/v2/pcv-1/addons/addon-object#period). For example, consider the following details:\n\n* The `unit_price` provided is $10\n* The addon billing period is 1 month.\n* The plan billing period is 3 months.\n* The addon is only billed for $10 on each subscription renewal.\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 addon. The value is in major units of the currency. Always returned when multi-decimal pricing is enabled.  \n**Note:**\n\nFor recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:\n\n* The `unit_price_in_decimal` provided is $10.75\n* The addon billing period is 1 month.\n* The plan billing period is 3 months.\n* The addon is only billed for $10.75 on each subscription renewal.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      },
                      "service_period" : {
                        "type" : "array",
                        "description" : "Specifies the service period of the addon in days. When the quote is converted, the [invoice.line_item.date_from](/docs/api/invoices/invoice-object#line_items)\nis set to current date/time and [invoice.line_item.date_to](/docs/api/invoices/invoice-object#line_items)\nis set to `service_period`\ndays ahead of [date_from](/docs/api/invoices/invoice-object#line_items)\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "charges" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for charges\n",
                    "properties" : {
                      "amount" : {
                        "type" : "array",
                        "description" : "The amount to be charged. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                        "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).\nApplicable only when multi-decimal pricing is enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      },
                      "description" : {
                        "type" : "array",
                        "description" : "Description for this charge\n",
                        "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)\nintegration.\n\n* consumed - Transaction is for an item that is consumed directly\n* vendor_use - Transaction is for an item that is subject to vendor use tax\n* wholesale - Transaction is a sale to another company that will resell your product or service to another consumer\n* retail - Transaction is a sale to an end user\n",
                          "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)\nintegration.\n",
                        "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)\nintegration.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      },
                      "service_period" : {
                        "type" : "array",
                        "description" : "Service period for charge\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "tax_providers_fields" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for tax_providers_fields\n",
                    "properties" : {
                      "provider_name" : {
                        "type" : "array",
                        "description" : "Name of the tax provider currently supported.\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 us.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "field_value" : {
                        "type" : "array",
                        "description" : "The value of the corresponding tax field.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  }
                },
                "required" : [ "customer_id" ],
                "example" : null
              },
              "encoding" : {
                "addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "charges" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "shipping_address" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "tax_providers_fields" : {
                  "style" : "deepObject",
                  "explode" : true
                }
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "quote" : {
                      "$ref" : "#/components/schemas/Quote",
                      "description" : "Resource object representing quote\n"
                    },
                    "quoted_charge" : {
                      "$ref" : "#/components/schemas/QuotedCharge",
                      "description" : "Resource object representing quoted_charge\n"
                    }
                  },
                  "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. Status can be updated to Accepted, Declined, and Closed.\n",
        "operationId" : "update_quote_status",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "quote-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/quote-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "status" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Status to update for the quote.\n\n* accepted - Accepted.\n* closed - Closed\n* declined - Declined.\n* proposed - Proposed.\n* voided - Voided.\n",
                    "enum" : [ "accepted", "declined", "proposed", "voided", "closed" ],
                    "example" : null
                  },
                  "comment" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "An internal [comment](/docs/api/comments)\nto 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)\nor any document such as the [Quote PDF](/docs/api/quotes/retrieve-quote-as-pdf)\n.\n",
                    "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\n"
                    },
                    "quoted_subscription" : {
                      "$ref" : "#/components/schemas/QuotedSubscription",
                      "description" : "Resource object representing quoted_subscription\n"
                    },
                    "quoted_charge" : {
                      "$ref" : "#/components/schemas/QuotedCharge",
                      "description" : "Resource object representing quoted_charge\n"
                    },
                    "quoted_ramp" : {
                      "$ref" : "#/components/schemas/QuotedRamp",
                      "description" : "Resource object representing quoted_ramp\n"
                    }
                  },
                  "required" : [ "quote" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/customers/{customer-id}/create_subscription_quote" : {
      "post" : {
        "tags" : [ "customers" ],
        "summary" : "Create quote for a new subscription",
        "description" : "Creates a quote for a new subscription under the customer specified.\n\nTo send this quote, use \"[Send Email](https://www.chargebee.com/docs/1.0/quotes.html#other-quote-actions_send-email)\" quote action in the Chargebee application.\n\nBased on the customer's reply, you can use [Update quote status](/docs/api/v2/pcv-1/quotes/update-quote-status) and [Convert a quote](/docs/api/v2/pcv-1/quotes/convert-a-quote) APIs for changing quote status and invoicing the customer, respectively.\n",
        "operationId" : "create_quote_for_a_new_subscription",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "customer-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/customer-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "name" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The quote name will be used as the pdf name of the quote.\n",
                    "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.\n",
                    "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.\n",
                    "example" : null
                  },
                  "billing_cycles" : {
                    "type" : "integer",
                    "format" : "int32",
                    "deprecated" : false,
                    "description" : "Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.\n",
                    "minimum" : 0,
                    "example" : null
                  },
                  "mandatory_addons_to_remove" : {
                    "type" : "array",
                    "deprecated" : false,
                    "description" : "List of addons IDs that are mandatory to the plan and has to be removed from the subscription.\n",
                    "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)\n.\n",
                    "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)\nfor Calendar Billing. Only applicable when using Calendar Billing. The default value is that which has been configured for the site.\n\n* delayed - Subscription period will be aligned with the configured billing date at the next renewal.\n* immediate - Subscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..\n",
                    "enum" : [ "immediate", "delayed" ],
                    "example" : null
                  },
                  "coupon_ids" : {
                    "type" : "array",
                    "deprecated" : false,
                    "description" : "Identifier of the coupon as a List. Coupon Codes can also be passed.\n",
                    "items" : {
                      "type" : "string",
                      "deprecated" : false,
                      "maxLength" : 100,
                      "example" : null
                    },
                    "example" : null
                  },
                  "subscription" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for subscription\n",
                    "properties" : {
                      "id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "A unique and immutable identifier for the subscription. If not provided, it is autogenerated.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "po_number" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Purchase order number for this subscription.\n",
                        "maxLength" : 100,
                        "example" : null
                      },
                      "plan_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Identifier of the plan for this subscription\n",
                        "maxLength" : 100,
                        "example" : null
                      },
                      "plan_quantity" : {
                        "type" : "integer",
                        "format" : "int32",
                        "default" : 1,
                        "deprecated" : false,
                        "description" : "Plan quantity for this subscription\n",
                        "minimum" : 1,
                        "example" : null
                      },
                      "plan_quantity_in_decimal" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "maxLength" : 33,
                        "example" : null
                      },
                      "plan_unit_price" : {
                        "type" : "integer",
                        "format" : "int64",
                        "deprecated" : false,
                        "description" : "Amount that will override the Plan's default price. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                        "minimum" : 0,
                        "example" : null
                      },
                      "plan_unit_price_in_decimal" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "When [price overriding](http://chargebee.com/docs/price-override.html )\nis enabled for the site, the price or per-unit price of the plan can be set here. The value [set for the plan](/docs/api/v2/pcv-1/plans/plan-object#price)\nis used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "maxLength" : 39,
                        "example" : null
                      },
                      "setup_fee" : {
                        "type" : "integer",
                        "format" : "int64",
                        "deprecated" : false,
                        "description" : "Amount that will override the default setup fee. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                        "minimum" : 0,
                        "example" : null
                      },
                      "trial_end" : {
                        "type" : "integer",
                        "format" : "unix-time",
                        "deprecated" : false,
                        "description" : "The time at which the trial ends for this subscription. Can be specified to override the default trial period.If **'0'**\nis passed, the subscription will be activated immediately.\n",
                        "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:\n\n* Backdating is enabled for subscription creation operations.\n* 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.\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, `subscription[start_date]` cannot be earlier than 14th February.\n",
                        "example" : null
                      },
                      "offline_payment_method" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The preferred offline payment method for the subscription.\n\n* uk_automated_bank_transfer - UK Automated Bank Transfer\n* us_automated_bank_transfer - US Automated Bank Transfer\n* boleto - Boleto\n* no_preference - No Preference\n* sepa_credit - SEPA Credit\n* jp_automated_bank_transfer - JP Automated Bank Transfer\n* mx_automated_bank_transfer - MX Automated Bank Transfer\n* bank_transfer - Bank Transfer\n* ach_credit - ACH Credit\n* custom - Custom\n* eu_automated_bank_transfer - EU Automated Bank Transfer\n* cash - Cash\n* check - Check\n",
                        "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`\nor a custom value depending on the [site configuration](https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms)\n.\n",
                        "maximum" : 100,
                        "minimum" : 1,
                        "example" : null
                      }
                    },
                    "required" : [ "plan_id" ],
                    "example" : null
                  },
                  "shipping_address" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for shipping_address\n",
                    "properties" : {
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The first name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The last name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "The email address.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "company" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The company name.\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The phone number.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line3" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 3\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "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`\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.\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://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.\n\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n* valid - Address was validated successfully.\n",
                        "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "contract_term" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for contract_term\n",
                    "properties" : {
                      "action_at_term_end" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Action to be taken when the contract term completes.\n\n* evergreen - Contract term completes and the subscription renews.\n* renew -\n  * 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).\n  * 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`](/docs/api/contract_terms/contract_term-object#contract_end)\n, 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.\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "Identifier of the addon. Multiple addons can be passed.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "default" : 1,
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_in_decimal" : {
                        "type" : "array",
                        "description" : "The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis 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 addon. The value depends on the [type of currency](/docs/api/getting-started).  \n**Note:**\n\nFor recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the [addon period](/docs/api/v2/pcv-1/addons/addon-object#period). For example, consider the following details:\n\n* The `unit_price` provided is $10\n* The addon billing period is 1 month.\n* The plan billing period is 3 months.\n* The addon is only billed for $10 on each subscription renewal.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price_in_decimal" : {
                        "type" : "array",
                        "description" : "When [price overriding](http://chargebee.com/docs/price-override.html )\nis enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)\nis used by default. However, the price provided here is considered as the price of the addon for an entire billing cycle of the subscription regardless of the value of the addon `period`.\nProvide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      },
                      "billing_cycles" : {
                        "type" : "array",
                        "description" : "Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "trial_end" : {
                        "type" : "array",
                        "description" : "The time at which the trial ends for the addon. This value can only be set for subscriptions that start with an `active`\nor `non-renewing`\nstatus. Once set, the value can't be changed. (Addon trial periods must be enabled by [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",
                        "items" : {
                          "type" : "integer",
                          "format" : "unix-time",
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "event_based_addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for event_based_addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "A unique 'id' used to identify the addon.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price" : {
                        "type" : "array",
                        "description" : "Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_in_decimal" : {
                        "type" : "array",
                        "description" : "The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 33,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price_in_decimal" : {
                        "type" : "array",
                        "description" : "When [price overriding](http://chargebee.com/docs/price-override.html )\nis enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)\nis used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      },
                      "service_period_in_days" : {
                        "type" : "array",
                        "description" : "Defines service period of the addon in days from the day of charge.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "maximum" : 4000,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "on_event" : {
                        "type" : "array",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "description" : "Event on which this addon will be charged.\n\n* plan_activation - Addon will be charged on plan activation.\n* subscription_activation - Addon will be charged on subscription activation.\n* subscription_creation - Addon will be charged on subscription creation.\n* subscription_trial_start - Addon will be charged when the trial period starts.\n* contract_termination - Addon will be charged on contract termination.\n",
                          "enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ],
                          "example" : null
                        },
                        "example" : null
                      },
                      "charge_once" : {
                        "type" : "array",
                        "description" : "If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.\n",
                        "items" : {
                          "type" : "boolean",
                          "default" : true,
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      },
                      "charge_on" : {
                        "type" : "array",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "description" : "Indicates when the non-recurring addon will be charged.\n\n* on_event - Charge for the addon will be applied on the occurrence of a specified event.\n* immediately - Charges for the addon will be applied immediately.\n",
                          "enum" : [ "immediately", "on_event" ],
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  }
                },
                "example" : null
              },
              "encoding" : {
                "addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "contract_term" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "event_based_addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "shipping_address" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "subscription" : {
                  "style" : "deepObject",
                  "explode" : true
                }
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "quote" : {
                      "$ref" : "#/components/schemas/Quote",
                      "description" : "Resource object representing quote\n"
                    },
                    "quoted_subscription" : {
                      "$ref" : "#/components/schemas/QuotedSubscription",
                      "description" : "Resource object representing quoted_subscription\n"
                    }
                  },
                  "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.\n",
        "operationId" : "list_quote_line_groups",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "quote-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/quote-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        }, {
          "name" : "limit",
          "in" : "query",
          "description" : "The number of resources to be returned.\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`\nto the value of `next_offset`\nobtained in the previous iteration of the API call.\n",
          "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`.\n",
                      "maxLength" : 1000,
                      "example" : null
                    }
                  },
                  "required" : [ "list" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/quotes/{quote-id}/edit_update_subscription_quote" : {
      "post" : {
        "tags" : [ "quotes" ],
        "summary" : "Edit quote for updating a subscription",
        "description" : "Edits a quote. This endpoint is for editing quotes that are for updating a subscription. To edit a quote for a new subscription, use [Edit quote for a new subscription](/docs/api/v2/pcv-1/quotes/edit-quote-for-a-new-subscription).\n",
        "operationId" : "edit_quote_for_updating_a_subscription",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "quote-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/quote-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "notes" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Notes specific to this quote that you want customers to see on the quote PDF.\n",
                    "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.\n",
                    "example" : null
                  },
                  "replace_addon_list" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "Should be true if the existing addons should be replaced with the ones that are being passed.\n",
                    "example" : null
                  },
                  "mandatory_addons_to_remove" : {
                    "type" : "array",
                    "deprecated" : false,
                    "description" : "List of addons IDs that are mandatory to the plan and has to be removed from the subscription.\n",
                    "items" : {
                      "type" : "string",
                      "deprecated" : false,
                      "maxLength" : 100,
                      "example" : null
                    },
                    "example" : null
                  },
                  "billing_cycles" : {
                    "type" : "integer",
                    "format" : "int32",
                    "deprecated" : false,
                    "description" : "The number of billing cycles the subscription runs before canceling. If not provided, then the billing cycles set for the plan is used.\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).\nIf a new term is started for the subscription due to this API call, then `terms_to_charge`\nis inclusive of this new term. See description for the `force_term_reset`\nparameter to learn more about when a subscription term is reset.\n",
                    "minimum" : 1,
                    "example" : null
                  },
                  "reactivate_from" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "If the subscription `status`\nis `cancelled`\nand it is being reactivated via this operation, this is the date/time at which the subscription should be reactivated.\n**Note:**\nIt is recommended not to pass this parameter along with `changed_scheduled_at`.\n`reactivate_from`\ncan 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:\n\n* Backdating must be enabled for subscription reactivation operations.\n* 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.\n* The date is on or after the last date/time any of the product catalog items of the subscription were changed.\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
                  },
                  "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)\nchosen for the site for calendar billing. Only applicable when using calendar billing.\n\n* immediate - Subscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..\n* delayed - Subscription period will be aligned with the configured billing date at the next renewal.\n",
                    "enum" : [ "immediate", "delayed" ],
                    "example" : null
                  },
                  "coupon_ids" : {
                    "type" : "array",
                    "deprecated" : false,
                    "description" : "Identifier of the coupon as a List. Coupon Codes can also be passed.\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.\n",
                    "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.\n\n* specific_date -\n  The change is carried out as of the date specified under `changes_scheduled_at`\n  .\n* immediately - The change is carried out immediately.\n",
                    "enum" : [ "immediately", "specific_date" ],
                    "example" : null
                  },
                  "changes_scheduled_at" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "When `change_option`\nis set to `specific_date`\n, then set the date/time at which the subscription change is to happen or has happened. `changes_scheduled_at`\ncan 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\n* Only the following changes can be backdated:\n\n* Changes in the recurring items or their prices.\n\n* Addition of non-recurring items.\n\n* Subscription `status` is `active`, `cancelled`, or `non_renewing`.\n\n* 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.\n\n* The date is on or after `current_term_start`.\n\n* The date is on or after the last date/time any of the following changes were made:\n\n* Changes in the recurring items or their prices.\n\n* Addition of non-recurring items.\n\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 subscription's plan is 2 months and today is 14th April, `changes_scheduled_at` cannot be earlier than 14th February.\n  .\n\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'.\n**Note**:\nSpecifying this value as 'false' has no impact on the default behaviour.\n",
                    "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.\n",
                    "example" : null
                  },
                  "subscription" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for subscription\n",
                    "properties" : {
                      "plan_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Identifier of the plan for this subscription\n",
                        "maxLength" : 100,
                        "example" : null
                      },
                      "plan_quantity" : {
                        "type" : "integer",
                        "format" : "int32",
                        "default" : 1,
                        "deprecated" : false,
                        "description" : "Represents the plan quantity for this subscription.\n",
                        "minimum" : 1,
                        "example" : null
                      },
                      "plan_unit_price" : {
                        "type" : "integer",
                        "format" : "int64",
                        "deprecated" : false,
                        "description" : "Amount that will override the Plan's default price. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                        "minimum" : 0,
                        "example" : null
                      },
                      "setup_fee" : {
                        "type" : "integer",
                        "format" : "int64",
                        "deprecated" : false,
                        "description" : "Amount that will override the default setup fee. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                        "minimum" : 0,
                        "example" : null
                      },
                      "plan_quantity_in_decimal" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "maxLength" : 33,
                        "example" : null
                      },
                      "plan_unit_price_in_decimal" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "When price overriding is enabled for the site, the price or per-unit price of the plan can be set here. The value [set for the plan](/docs/api/v2/pcv-1/plans/plan-object#price)\nis used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "maxLength" : 39,
                        "example" : null
                      },
                      "start_date" : {
                        "type" : "integer",
                        "format" : "unix-time",
                        "deprecated" : false,
                        "description" : "The new start date of a `future`\nsubscription. Applicable only for `future`\nsubscriptions.\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. This is only allowed when the subscription `status`\nis `future`\n, `in_trial`\n, or `cancelled`.\nAlso, the value must not be earlier than `changes_scheduled_at`\nor `start_date`.\n**Note** :\nThis parameter can be backdated (set to a value in the past) only when the subscription is in `cancelled`\nor `in_trial`\n`status`.\nDo this to keep a record of when the trial ended in case it ended at some point in the past. When `trial_end`\nis backdated, the subscription immediately goes into `active`\nor `non_renewing`\nstatus.\n",
                        "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.\n\n* off - Automatic collection of charges will not be made for this subscription. Use this for offline payments.\n* on - Whenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.\n",
                        "enum" : [ "on", "off" ],
                        "example" : null
                      },
                      "offline_payment_method" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The preferred offline payment method for the subscription.\n\n* uk_automated_bank_transfer - UK Automated Bank Transfer\n* jp_automated_bank_transfer - JP Automated Bank Transfer\n* bank_transfer - Bank Transfer\n* us_automated_bank_transfer - US Automated Bank Transfer\n* boleto - Boleto\n* no_preference - No Preference\n* sepa_credit - SEPA Credit\n* mx_automated_bank_transfer - MX Automated Bank Transfer\n* ach_credit - ACH Credit\n* custom - Custom\n* eu_automated_bank_transfer - EU Automated Bank Transfer\n* cash - Cash\n* check - Check\n",
                        "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`\nor a custom value depending on the [site configuration](https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms)\n.\n",
                        "maximum" : 100,
                        "minimum" : 1,
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "billing_address" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for billing_address\n",
                    "properties" : {
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The first name of the billing contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The last name of the billing contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "The email address.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "company" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The company name.\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The phone number.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line3" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 3\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "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`\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.\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://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.\n\n* valid - Address was validated successfully.\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n",
                        "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "shipping_address" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for shipping_address\n",
                    "properties" : {
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The first name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The last name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "The email address.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "company" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The company name.\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The phone number.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line3" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 3\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "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`\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.\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://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.\n\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n* valid - Address was validated successfully.\n",
                        "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "customer" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for customer\n",
                    "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.\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).\nOnly applicable specifically for customers with [billing_address](/docs/api/customers/customer-object#billing_address)\n\n`country`\nas `XI`\n(which is **United Kingdom - Northern Ireland**\n).\n\nWhen you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\nin 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\nthe Brexit configuration, you have the option of setting [billing_address](/docs/api/customers/customer-object#billing_address)\n\n`country`\nas `XI`.\nThat's the code for **United Kingdom - Northern Ireland** .\nThe first two characters of the VAT number in such a case is\n`XI`\nby default. However, if the VAT number was registered in UK, the value should be `GB`.\nSet\n`vat_number_prefix`\nto `GB`\nfor such cases.\n",
                        "maxLength" : 10,
                        "example" : null
                      },
                      "registered_for_gst" : {
                        "type" : "boolean",
                        "deprecated" : false,
                        "description" : "Confirms that a customer is registered under GST. If set to `true`\nthen the [Reverse Charge Mechanism](https://www.chargebee.com/docs/australian-gst.html#reverse-charge-mechanism)\nis applicable. This field is applicable only when Australian GST is configured for your site.\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "contract_term" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for contract_term\n",
                    "properties" : {
                      "action_at_term_end" : {
                        "type" : "string",
                        "default" : "renew",
                        "deprecated" : false,
                        "description" : "Action to be taken when the contract term completes.\n\n* evergreen - Contract term completes and the subscription renews.\n* renew -\n  * 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).\n  * The `action_at_term_end` for the new contract term is set to `renew`.\n* renew_once -\n  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).\n\n  * The `action_at_term_end` for the new contract term is set to `cancel`.\n* cancel - Contract term completes and subscription is canceled.\n",
                        "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)\n, 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.\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "Identifier of the addon. Multiple addons can be passed.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "default" : 1,
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price" : {
                        "type" : "array",
                        "description" : "The price or per-unit-price of the addon. The value depends on the [type of currency](/docs/api/getting-started).  \n**Note:**\n\nFor recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the [addon period](/docs/api/v2/pcv-1/addons/addon-object#period). For example, consider the following details:\n\n* The `unit_price` provided is $10\n* The addon billing period is 1 month.\n* The plan billing period is 3 months.\n* The addon is only billed for $10 on each subscription renewal.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "billing_cycles" : {
                        "type" : "array",
                        "description" : "Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_in_decimal" : {
                        "type" : "array",
                        "description" : "The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 33,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price_in_decimal" : {
                        "type" : "array",
                        "description" : "When [price overriding](http://chargebee.com/docs/price-override.html )\nis enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)\nis used by default. However, the price provided here is considered as the price of the addon for an entire billing cycle of the subscription regardless of the value of the addon `period`.\nProvide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      },
                      "trial_end" : {
                        "type" : "array",
                        "description" : "The time at which the trial ends for the addon. To update this value, redo the complete addon set using [`replace_addon_list`](/docs/api/v2/pcv-1/subscriptions/update-a-subscription#replace_addon_list).\n(Addon trial periods must be enabled by [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",
                        "items" : {
                          "type" : "integer",
                          "format" : "unix-time",
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "event_based_addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for event_based_addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "A unique 'id' used to identify the addon.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price" : {
                        "type" : "array",
                        "description" : "Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "service_period_in_days" : {
                        "type" : "array",
                        "description" : "Defines service period of the addon in days from the day of charge.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "maximum" : 4000,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "charge_on" : {
                        "type" : "array",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "description" : "Indicates when the non-recurring addon will be charged.\n\n* immediately - Charges for the addon will be applied immediately.\n* on_event - Charge for the addon will be applied on the occurrence of a specified event.\n",
                          "enum" : [ "immediately", "on_event" ],
                          "example" : null
                        },
                        "example" : null
                      },
                      "on_event" : {
                        "type" : "array",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "description" : "Event on which this addon will be charged.\n\n* plan_activation - Addon will be charged on plan activation.\n* contract_termination - Addon will be charged on contract termination.\n* subscription_activation - Addon will be charged on subscription activation.\n* subscription_creation - Addon will be charged on subscription creation.\n* subscription_trial_start - Addon will be charged when the trial period starts.\n",
                          "enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ],
                          "example" : null
                        },
                        "example" : null
                      },
                      "charge_once" : {
                        "type" : "array",
                        "description" : "If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.\n",
                        "items" : {
                          "type" : "boolean",
                          "default" : true,
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_in_decimal" : {
                        "type" : "array",
                        "description" : "The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 33,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price_in_decimal" : {
                        "type" : "array",
                        "description" : "When [price overriding](http://chargebee.com/docs/price-override.html )\nis enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)\nis used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  }
                },
                "example" : null
              },
              "encoding" : {
                "addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "billing_address" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "contract_term" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "customer" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "event_based_addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "shipping_address" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "subscription" : {
                  "style" : "deepObject",
                  "explode" : true
                }
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "quote" : {
                      "$ref" : "#/components/schemas/Quote",
                      "description" : "Resource object representing quote\n"
                    },
                    "quoted_subscription" : {
                      "$ref" : "#/components/schemas/QuotedSubscription",
                      "description" : "Resource object representing quoted_subscription\n"
                    }
                  },
                  "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.\n",
        "operationId" : "extend_expiry_date",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "quote-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/quote-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "valid_till" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "Quote will be valid till this date. After this date quote will be marked as closed.\n",
                    "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\n"
                    },
                    "quoted_subscription" : {
                      "$ref" : "#/components/schemas/QuotedSubscription",
                      "description" : "Resource object representing quoted_subscription\n"
                    },
                    "quoted_charge" : {
                      "$ref" : "#/components/schemas/QuotedCharge",
                      "description" : "Resource object representing quoted_charge\n"
                    },
                    "quoted_ramp" : {
                      "$ref" : "#/components/schemas/QuotedRamp",
                      "description" : "Resource object representing quoted_ramp\n"
                    }
                  },
                  "required" : [ "quote" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/quotes/{quote-id}/edit_create_subscription_quote" : {
      "post" : {
        "tags" : [ "quotes" ],
        "summary" : "Edit quote for a new subscription",
        "description" : "Edits a quote. This endpoint is for quotes that are for new subscriptions. To edit a quote that is for updating a subscription, use [Edit quote for updating a subscription](/docs/api/v2/pcv-1/quotes/edit-quote-for-updating-a-subscription).\n",
        "operationId" : "edit_quote_for_a_new_subscription",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "quote-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/quote-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "notes" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Notes specific to this quote that you want customers to see on the quote PDF.\n",
                    "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.\n",
                    "example" : null
                  },
                  "billing_cycles" : {
                    "type" : "integer",
                    "format" : "int32",
                    "deprecated" : false,
                    "description" : "Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.\n",
                    "minimum" : 0,
                    "example" : null
                  },
                  "mandatory_addons_to_remove" : {
                    "type" : "array",
                    "deprecated" : false,
                    "description" : "List of addons IDs that are mandatory to the plan and has to be removed from the subscription.\n",
                    "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)\n.\n",
                    "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)\nfor Calendar Billing. Only applicable when using Calendar Billing. The default value is that which has been configured for the site.\n\n* delayed - Subscription period will be aligned with the configured billing date at the next renewal.\n* immediate - Subscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..\n",
                    "enum" : [ "immediate", "delayed" ],
                    "example" : null
                  },
                  "coupon_ids" : {
                    "type" : "array",
                    "deprecated" : false,
                    "description" : "Identifier of the coupon as a List. Coupon Codes can also be passed.\n",
                    "items" : {
                      "type" : "string",
                      "deprecated" : false,
                      "maxLength" : 100,
                      "example" : null
                    },
                    "example" : null
                  },
                  "subscription" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for subscription\n",
                    "properties" : {
                      "id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "A unique and immutable identifier for the subscription. If not provided, it is autogenerated.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "po_number" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Purchase order number for this subscription.\n",
                        "maxLength" : 100,
                        "example" : null
                      },
                      "plan_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Identifier of the plan for this subscription\n",
                        "maxLength" : 100,
                        "example" : null
                      },
                      "plan_quantity" : {
                        "type" : "integer",
                        "format" : "int32",
                        "default" : 1,
                        "deprecated" : false,
                        "description" : "Plan quantity for this subscription\n",
                        "minimum" : 1,
                        "example" : null
                      },
                      "plan_quantity_in_decimal" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "maxLength" : 33,
                        "example" : null
                      },
                      "plan_unit_price" : {
                        "type" : "integer",
                        "format" : "int64",
                        "deprecated" : false,
                        "description" : "Amount that will override the Plan's default price. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                        "minimum" : 0,
                        "example" : null
                      },
                      "plan_unit_price_in_decimal" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "When [price overriding](http://chargebee.com/docs/price-override.html )\nis enabled for the site, the price or per-unit price of the plan can be set here. The value [set for the plan](/docs/api/v2/pcv-1/plans/plan-object#price)\nis used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "maxLength" : 39,
                        "example" : null
                      },
                      "setup_fee" : {
                        "type" : "integer",
                        "format" : "int64",
                        "deprecated" : false,
                        "description" : "Amount that will override the default setup fee. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                        "minimum" : 0,
                        "example" : null
                      },
                      "trial_end" : {
                        "type" : "integer",
                        "format" : "unix-time",
                        "deprecated" : false,
                        "description" : "The time at which the trial ends for this subscription. Can be specified to override the default trial period.If **'0'**\nis passed, the subscription will be activated immediately.\n",
                        "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:\n\n* Backdating is enabled for subscription creation operations.\n* 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.\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, `subscription[start_date]` cannot be earlier than 14th February.\n",
                        "example" : null
                      },
                      "offline_payment_method" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The preferred offline payment method for the subscription.\n\n* uk_automated_bank_transfer - UK Automated Bank Transfer\n* us_automated_bank_transfer - US Automated Bank Transfer\n* boleto - Boleto\n* no_preference - No Preference\n* sepa_credit - SEPA Credit\n* jp_automated_bank_transfer - JP Automated Bank Transfer\n* mx_automated_bank_transfer - MX Automated Bank Transfer\n* bank_transfer - Bank Transfer\n* ach_credit - ACH Credit\n* custom - Custom\n* eu_automated_bank_transfer - EU Automated Bank Transfer\n* cash - Cash\n* check - Check\n",
                        "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`\nor a custom value depending on the [site configuration](https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms)\n.\n",
                        "maximum" : 100,
                        "minimum" : 1,
                        "example" : null
                      }
                    },
                    "required" : [ "plan_id" ],
                    "example" : null
                  },
                  "shipping_address" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for shipping_address\n",
                    "properties" : {
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The first name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The last name of the contact.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "The email address.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "company" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The company name.\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The phone number.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line3" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 3\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                        "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`\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.\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://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.\n\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n* valid - Address was validated successfully.\n",
                        "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "contract_term" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for contract_term\n",
                    "properties" : {
                      "action_at_term_end" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Action to be taken when the contract term completes.\n\n* evergreen - Contract term completes and the subscription renews.\n* renew -\n  * 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).\n  * 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`](/docs/api/contract_terms/contract_term-object#contract_end)\n, 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.\n",
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "Identifier of the addon. Multiple addons can be passed.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "default" : 1,
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_in_decimal" : {
                        "type" : "array",
                        "description" : "The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis 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 addon. The value depends on the [type of currency](/docs/api/getting-started).  \n**Note:**\n\nFor recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the [addon period](/docs/api/v2/pcv-1/addons/addon-object#period). For example, consider the following details:\n\n* The `unit_price` provided is $10\n* The addon billing period is 1 month.\n* The plan billing period is 3 months.\n* The addon is only billed for $10 on each subscription renewal.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price_in_decimal" : {
                        "type" : "array",
                        "description" : "When [price overriding](http://chargebee.com/docs/price-override.html )\nis enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)\nis used by default. However, the price provided here is considered as the price of the addon for an entire billing cycle of the subscription regardless of the value of the addon `period`.\nProvide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      },
                      "billing_cycles" : {
                        "type" : "array",
                        "description" : "Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "trial_end" : {
                        "type" : "array",
                        "description" : "The time at which the trial ends for the addon. This value can only be set for subscriptions that start with an `active`\nor `non-renewing`\nstatus. Once set, the value can't be changed. (Addon trial periods must be enabled by [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",
                        "items" : {
                          "type" : "integer",
                          "format" : "unix-time",
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "event_based_addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for event_based_addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "A unique 'id' used to identify the addon.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price" : {
                        "type" : "array",
                        "description" : "Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int64",
                          "deprecated" : false,
                          "minimum" : 0,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_in_decimal" : {
                        "type" : "array",
                        "description" : "The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 33,
                          "example" : null
                        },
                        "example" : null
                      },
                      "unit_price_in_decimal" : {
                        "type" : "array",
                        "description" : "When [price overriding](http://chargebee.com/docs/price-override.html )\nis enabled for the site, the price or per-unit price of the addon can be set here. The value [set for the addon](/docs/api/v2/pcv-1/addons/addon-object#price)\nis used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      },
                      "service_period_in_days" : {
                        "type" : "array",
                        "description" : "Defines service period of the addon in days from the day of charge.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "maximum" : 4000,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "on_event" : {
                        "type" : "array",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "description" : "Event on which this addon will be charged.\n\n* plan_activation - Addon will be charged on plan activation.\n* subscription_activation - Addon will be charged on subscription activation.\n* subscription_creation - Addon will be charged on subscription creation.\n* subscription_trial_start - Addon will be charged when the trial period starts.\n* contract_termination - Addon will be charged on contract termination.\n",
                          "enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ],
                          "example" : null
                        },
                        "example" : null
                      },
                      "charge_once" : {
                        "type" : "array",
                        "description" : "If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.\n",
                        "items" : {
                          "type" : "boolean",
                          "default" : true,
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      },
                      "charge_on" : {
                        "type" : "array",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "description" : "Indicates when the non-recurring addon will be charged.\n\n* on_event - Charge for the addon will be applied on the occurrence of a specified event.\n* immediately - Charges for the addon will be applied immediately.\n",
                          "enum" : [ "immediately", "on_event" ],
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  }
                },
                "example" : null
              },
              "encoding" : {
                "addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "contract_term" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "event_based_addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "shipping_address" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "subscription" : {
                  "style" : "deepObject",
                  "explode" : true
                }
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "quote" : {
                      "$ref" : "#/components/schemas/Quote",
                      "description" : "Resource object representing quote\n"
                    },
                    "quoted_subscription" : {
                      "$ref" : "#/components/schemas/QuotedSubscription",
                      "description" : "Resource object representing quoted_subscription\n"
                    }
                  },
                  "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" : "**Important**\n\nFor sites where both [legacy and latest](/docs/api/v2/pcv-1/upgrade#retrieving-api-responses-in-latest-api-format) product catalog versions are active, GET API requests return responses in a `compat` format by default. This format works with both latest and legacy Product Catalog.\n\n**Override options:**\n\n* `chargebee-response-schema-type: items` → Return response in latest product catalog format only.\n* `chargebee-response-schema-type: plans_addons` → Return response in legacy product catalog format only.\n\nList all quotes.\n",
        "operationId" : "list_quotes",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "limit",
          "in" : "query",
          "description" : "The number of resources to be returned.\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`\nto the value of `next_offset`\nobtained in the previous iteration of the API call.\n",
          "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**\n' attribute will be '**true**\n'.\n",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "boolean",
            "default" : false,
            "example" : null
          }
        }, {
          "name" : "id",
          "in" : "query",
          "description" : "optional, string filter\n\nThe quote number. Acts as a identifier for quote and typically generated sequentially.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*id\\[is\\] = \"123\"*\n",
          "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\n\nThe identifier of the customer this quote belongs to.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*customer_id\\[is\\] = \"4gmiXbsjdm\"*\n",
          "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\n\nTo filter based on subscription_id.\nNOTE: Not to be used if *consolidated invoicing*\nfeature is enabled.\n**Supported operators :**\nis, is_not, starts_with, is_present, in, not_in\n\n**Example →**\n*subscription_id\\[is\\] = \"4gmiXbsjdm\"*\n",
          "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\n\nCurrent status of this quote. Possible values are : open, accepted, declined, invoiced, closed.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*status\\[is_not\\] = \"open\"*\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "example" : "open",
            "properties" : {
              "is" : {
                "type" : "string",
                "description" : "* `open` - Open\n* `accepted` - Accepted.\n* `declined` - Declined.\n* `invoiced` - Invoiced\n* `closed` - Closed\n* `pending_approval` - Pending Approval\n* `approval_rejected` - Approval Rejected\n* `proposed` - Proposed.\n* `voided` - Voided.\n* `expired` - Expired",
                "enum" : [ "open", "accepted", "declined", "invoiced", "closed", "pending_approval", "approval_rejected", "proposed", "voided", "expired" ],
                "example" : null
              },
              "is_not" : {
                "type" : "string",
                "description" : "* `open` - Open\n* `accepted` - Accepted.\n* `declined` - Declined.\n* `invoiced` - Invoiced\n* `closed` - Closed\n* `pending_approval` - Pending Approval\n* `approval_rejected` - Approval Rejected\n* `proposed` - Proposed.\n* `voided` - Voided.\n* `expired` - Expired",
                "enum" : [ "open", "accepted", "declined", "invoiced", "closed", "pending_approval", "approval_rejected", "proposed", "voided", "expired" ],
                "example" : null
              },
              "in" : {
                "type" : "string",
                "description" : "* `open` - Open\n* `accepted` - Accepted.\n* `declined` - Declined.\n* `invoiced` - Invoiced\n* `closed` - Closed\n* `pending_approval` - Pending Approval\n* `approval_rejected` - Approval Rejected\n* `proposed` - Proposed.\n* `voided` - Voided.\n* `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\n* `accepted` - Accepted.\n* `declined` - Declined.\n* `invoiced` - Invoiced\n* `closed` - Closed\n* `pending_approval` - Pending Approval\n* `approval_rejected` - Approval Rejected\n* `proposed` - Proposed.\n* `voided` - Voided.\n* `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\n\nCreation date of the quote. Typically this is the date on which quote is generated.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*date\\[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\nTo filter based on updated at. This attribute will be present only if the resource has been updated after 2016-09-28.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*updated_at\\[after\\] = \"1243545465\"*\n",
          "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\n\nSorts based on the specified attribute.\n**Supported attributes :**\ndate\n\n**Supported sort-orders :**\nasc, desc\n\n**Example →**\n*sort_by\\[asc\\] = \"date\"*\n\nThis will sort the result based on the 'date' attribute in ascending(earliest first) order.\n",
          "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\n"
                          },
                          "quoted_subscription" : {
                            "$ref" : "#/components/schemas/QuotedSubscription",
                            "description" : "Resource object representing quoted_subscription\n"
                          },
                          "quoted_ramp" : {
                            "$ref" : "#/components/schemas/QuotedRamp",
                            "description" : "Resource object representing quoted_ramp\n"
                          }
                        },
                        "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`.\n",
                      "maxLength" : 1000,
                      "example" : null
                    }
                  },
                  "required" : [ "list" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/quotes/{quote-id}/pdf" : {
      "post" : {
        "tags" : [ "quotes" ],
        "summary" : "Retrieve quote as PDF",
        "description" : "Retrieves the quote as a PDF. The returned URL is secure, allows download and expires in 60 minutes.\n",
        "operationId" : "retrieve_quote_as_pdf",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "quote-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/quote-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "consolidated_view" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "When true, the quote PDF has summary of all charges on the quote. When false, the quote PDF has a detailed view of charges grouped by charge event. This parameter does not affect one-time quotes.\n",
                    "example" : null
                  },
                  "disposition_type" : {
                    "type" : "string",
                    "default" : "attachment",
                    "deprecated" : false,
                    "description" : "Determines the pdf should be rendered as inline or attachment in the browser.\n\n* attachment - PDF is rendered as attachment in the browser\n* inline - PDF is rendered as inline in the browser\n",
                    "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\n"
                    }
                  },
                  "required" : [ "download" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/quotes/{quote-id}/convert" : {
      "post" : {
        "tags" : [ "quotes" ],
        "summary" : "Convert a quote",
        "description" : "This API is to convert a quote to an invoice.\n",
        "operationId" : "convert_a_quote",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "quote-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/quote-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "invoice_date" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "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`\n, 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`\nand `line_item_taxes`\nare computed based on the tax configuration as of `invoice_date`.\nWhen passing this parameter, the following prerequisites must be met:\n\n* `invoice_date` must be in the past.\n* `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.\n* The date is not earlier than `quoted_subscription.start_date` or `quoted_subscription.changes_scheduled_at` (whichever is applicable).\n* `invoice_immediately` must be `true`. .\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).\nThe 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
                  },
                  "subscription" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for subscription\n",
                    "properties" : {
                      "id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Applicable only for create subscription quote.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "auto_collection" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Applicable only for create subscription quote.\n\n* off - Automatic collection of charges will not be made for this subscription. Use this for offline payments.\n* on - Whenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.\n",
                        "enum" : [ "on", "off" ],
                        "example" : null
                      },
                      "po_number" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Purchase order number for this subscription.\n",
                        "maxLength" : 100,
                        "example" : null
                      }
                    },
                    "example" : null
                  }
                },
                "example" : null
              },
              "encoding" : {
                "subscription" : {
                  "style" : "deepObject",
                  "explode" : true
                }
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "quote" : {
                      "$ref" : "#/components/schemas/Quote",
                      "description" : "Resource object representing quote\n"
                    },
                    "quoted_subscription" : {
                      "$ref" : "#/components/schemas/QuotedSubscription",
                      "description" : "Resource object representing quoted_subscription\n"
                    },
                    "quoted_charge" : {
                      "$ref" : "#/components/schemas/QuotedCharge",
                      "description" : "Resource object representing quoted_charge\n"
                    },
                    "quoted_ramp" : {
                      "$ref" : "#/components/schemas/QuotedRamp",
                      "description" : "Resource object representing quoted_ramp\n"
                    },
                    "customer" : {
                      "$ref" : "#/components/schemas/Customer",
                      "description" : "Resource object representing customer\n"
                    },
                    "subscription" : {
                      "$ref" : "#/components/schemas/Subscription",
                      "description" : "Resource object representing subscription\n"
                    },
                    "invoice" : {
                      "$ref" : "#/components/schemas/Invoice",
                      "description" : "Resource object representing invoice\n"
                    },
                    "credit_note" : {
                      "$ref" : "#/components/schemas/CreditNote",
                      "description" : "Resource object representing credit_note\n"
                    },
                    "unbilled_charges" : {
                      "type" : "array",
                      "description" : "Resource object representing unbilled_charge\n",
                      "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 an existing quote using this API.\n",
        "operationId" : "delete_a_quote",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "quote-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/quote-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "comment" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Reason for deleting this transaction. This comment will be added to the associated entity.\n",
                    "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\n"
                    },
                    "quoted_subscription" : {
                      "$ref" : "#/components/schemas/QuotedSubscription",
                      "description" : "Resource object representing quoted_subscription\n"
                    },
                    "quoted_charge" : {
                      "$ref" : "#/components/schemas/QuotedCharge",
                      "description" : "Resource object representing quoted_charge\n"
                    },
                    "quoted_ramp" : {
                      "$ref" : "#/components/schemas/QuotedRamp",
                      "description" : "Resource object representing quoted_ramp\n"
                    }
                  },
                  "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",
        "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" : "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",
          "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" : "entity_id",
          "in" : "query",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "description" : "Filter by entity_id",
            "properties" : {
              "is" : {
                "type" : "string",
                "minLength" : 1,
                "example" : null
              }
            },
            "example" : null
          }
        }, {
          "name" : "start_date",
          "in" : "query",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "description" : "Filter lock-mode entitlements by ramp start date (unix timestamp). Use with end_date[on].",
            "example" : "1780252200",
            "properties" : {
              "on" : {
                "type" : "string",
                "format" : "unix-time",
                "pattern" : "^\\d{10}$",
                "example" : null
              }
            }
          }
        }, {
          "name" : "end_date",
          "in" : "query",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "description" : "Filter lock-mode entitlements by ramp end date (unix timestamp). Use with start_date[on].",
            "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" : [ ]
        } ]
      }
    },
    "/plans/{plan-id}/unarchive" : {
      "post" : {
        "tags" : [ "plans" ],
        "summary" : "Unarchive a plan",
        "description" : "This endpoint unarchives a specific plan which was [archived](/docs/api/v2/pcv-1/plans/plan-object#status)\nearlier.\n",
        "operationId" : "unarchive_a_plan",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "plan-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/plan-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "plan" : {
                      "$ref" : "#/components/schemas/Plan",
                      "description" : "Resource object representing plan\n"
                    }
                  },
                  "required" : [ "plan" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/plans/{plan-id}/delete" : {
      "post" : {
        "tags" : [ "plans" ],
        "summary" : "Delete a plan",
        "description" : "Deletes or archives a plan. This endpoint behaves differently based on the scenarios listed below:\n\n* When the plan has subscriptions/invoices linked, it is not deleted. Instead, it is moved to the [archived](/docs/api/v2/pcv-1/plans/plan-object#status) state. Subscriptions already on it continue to renew. However, until the plan is unarchived,\n  * No other subscription can use the plan\n  * You cannot update the plan\n* When the plan does not have any subscriptions or invoices linked to it, the endpoint permanently deletes the plan from your Chargebee site. You cannot undo this action.\n",
        "operationId" : "delete_a_plan",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "plan-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/plan-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "plan" : {
                      "$ref" : "#/components/schemas/Plan",
                      "description" : "Resource object representing plan\n"
                    }
                  },
                  "required" : [ "plan" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/plans/copy" : {
      "post" : {
        "tags" : [ "plans" ],
        "summary" : "Copy a plan",
        "description" : "Creates a plan in this site by copying its configurations from another site. Copying of archived plans is not supported.  \n**Note:**\nThe attribute *tax_profile_id*\nis not copied. In effect, if the plan is taxable, it will be mapped to the *Primary*\ntax profile.\n",
        "operationId" : "copy_a_plan",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "from_site" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Your Chargebee site name having the plan to be copied.\n**Note:**\nUnless 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)\nto have this allow-listed.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "id_at_from_site" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Id of the plan to be copied. The new plan created in this site will have the same Id.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Id of copied plan in this site.\n",
                    "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.\n",
                    "example" : null
                  }
                },
                "required" : [ "from_site", "id_at_from_site" ],
                "example" : null
              },
              "encoding" : { }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "plan" : {
                      "$ref" : "#/components/schemas/Plan",
                      "description" : "Resource object representing plan\n"
                    }
                  },
                  "required" : [ "plan" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/plans" : {
      "get" : {
        "tags" : [ "plans" ],
        "summary" : "List plans",
        "description" : "This API fetches all the `active` and `archived` plans. If the limit parameter is not set, it will return upto 10 plans.\n",
        "operationId" : "list_plans",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "limit",
          "in" : "query",
          "description" : "The number of resources to be returned.\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`\nto the value of `next_offset`\nobtained in the previous iteration of the API call.\n",
          "required" : false,
          "deprecated" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "maxLength" : 1000,
            "example" : null
          }
        }, {
          "name" : "id",
          "in" : "query",
          "description" : "optional, string filter\n\nA unique ID for your system to identify the plan.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*id\\[is\\] = \"Enterprise\"*\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "example" : "Enterprise",
            "properties" : {
              "is" : {
                "type" : "string",
                "minLength" : 1,
                "example" : null
              },
              "is_not" : {
                "type" : "string",
                "minLength" : 1,
                "example" : null
              },
              "starts_with" : {
                "type" : "string",
                "minLength" : 1,
                "example" : null
              },
              "in" : {
                "type" : "string",
                "pattern" : "^\\[(.*)(,.*)*\\]$",
                "example" : null
              },
              "not_in" : {
                "type" : "string",
                "pattern" : "^\\[(.*)(,.*)*\\]$",
                "example" : null
              }
            }
          }
        }, {
          "name" : "name",
          "in" : "query",
          "description" : "optional, string filter\n\nThe display name used in web interface for identifying the plan.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*name\\[is\\] = \"plan_enterprise\"*\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "example" : "plan_enterprise",
            "properties" : {
              "is" : {
                "type" : "string",
                "minLength" : 1,
                "example" : null
              },
              "is_not" : {
                "type" : "string",
                "minLength" : 1,
                "example" : null
              },
              "starts_with" : {
                "type" : "string",
                "minLength" : 1,
                "example" : null
              },
              "in" : {
                "type" : "string",
                "pattern" : "^\\[(.*)(,.*)*\\]$",
                "example" : null
              },
              "not_in" : {
                "type" : "string",
                "pattern" : "^\\[(.*)(,.*)*\\]$",
                "example" : null
              }
            }
          }
        }, {
          "name" : "price",
          "in" : "query",
          "description" : "optional, in cents filter\n\nThe price of the plan. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n**Supported operators :**\nis, is_not, lt, lte, gt, gte, between\n\n**Example →**\n*price\\[gte\\] = \"1200\"*\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "example" : "1200",
            "properties" : {
              "is" : {
                "type" : "string",
                "format" : "number",
                "pattern" : "^-?\\d+$",
                "example" : null
              },
              "is_not" : {
                "type" : "string",
                "format" : "number",
                "pattern" : "^-?\\d+$",
                "example" : null
              },
              "lt" : {
                "type" : "string",
                "format" : "number",
                "pattern" : "^-?\\d+$",
                "example" : null
              },
              "lte" : {
                "type" : "string",
                "format" : "number",
                "pattern" : "^-?\\d+$",
                "example" : null
              },
              "gt" : {
                "type" : "string",
                "format" : "number",
                "pattern" : "^-?\\d+$",
                "example" : null
              },
              "gte" : {
                "type" : "string",
                "format" : "number",
                "pattern" : "^-?\\d+$",
                "example" : null
              },
              "between" : {
                "type" : "string",
                "pattern" : "^\\[-?\\d+,-?\\d+\\]$",
                "example" : null
              }
            }
          }
        }, {
          "name" : "period",
          "in" : "query",
          "description" : "optional, integer filter\n\nDefines billing frequency. Example: to bill customer every 3 months, provide \"3\" here.\n**Supported operators :**\nis, is_not, lt, lte, gt, gte, between\n\n**Example →**\n*period\\[lte\\] = \"3\"*\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "example" : "3",
            "properties" : {
              "is" : {
                "type" : "string",
                "format" : "number",
                "pattern" : "^-?\\d+$",
                "example" : null
              },
              "is_not" : {
                "type" : "string",
                "format" : "number",
                "pattern" : "^-?\\d+$",
                "example" : null
              },
              "lt" : {
                "type" : "string",
                "format" : "number",
                "pattern" : "^-?\\d+$",
                "example" : null
              },
              "lte" : {
                "type" : "string",
                "format" : "number",
                "pattern" : "^-?\\d+$",
                "example" : null
              },
              "gt" : {
                "type" : "string",
                "format" : "number",
                "pattern" : "^-?\\d+$",
                "example" : null
              },
              "gte" : {
                "type" : "string",
                "format" : "number",
                "pattern" : "^-?\\d+$",
                "example" : null
              },
              "between" : {
                "type" : "string",
                "pattern" : "^\\[-?\\d+,-?\\d+\\]$",
                "example" : null
              }
            }
          }
        }, {
          "name" : "period_unit",
          "in" : "query",
          "description" : "optional, enumerated string filter\n\nDefines billing frequency in association with billing period. Possible values are : day, week, month, year.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*period_unit\\[is\\] = \"month\"*\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "example" : "month",
            "properties" : {
              "is" : {
                "type" : "string",
                "description" : "* `day` - Charge based on day(s)\n* `week` - Charge based on week(s)\n* `month` - Charge based on month(s)\n* `year` - Charge based on year(s)",
                "enum" : [ "day", "week", "month", "year" ],
                "example" : null
              },
              "is_not" : {
                "type" : "string",
                "description" : "* `day` - Charge based on day(s)\n* `week` - Charge based on week(s)\n* `month` - Charge based on month(s)\n* `year` - Charge based on year(s)",
                "enum" : [ "day", "week", "month", "year" ],
                "example" : null
              },
              "in" : {
                "type" : "string",
                "description" : "* `day` - Charge based on day(s)\n* `week` - Charge based on week(s)\n* `month` - Charge based on month(s)\n* `year` - Charge based on year(s)",
                "enum" : [ "day", "week", "month", "year" ],
                "pattern" : "^\\[(day|week|month|year)(,(day|week|month|year))*\\]$",
                "example" : null
              },
              "not_in" : {
                "type" : "string",
                "description" : "* `day` - Charge based on day(s)\n* `week` - Charge based on week(s)\n* `month` - Charge based on month(s)\n* `year` - Charge based on year(s)",
                "enum" : [ "day", "week", "month", "year" ],
                "pattern" : "^\\[(day|week|month|year)(,(day|week|month|year))*\\]$",
                "example" : null
              }
            }
          }
        }, {
          "name" : "trial_period",
          "in" : "query",
          "description" : "optional, integer filter\n\nThe free time window for your customer to try your product.\n**Supported operators :**\nis, is_not, lt, lte, gt, gte, between, is_present\n\n**Example →**\n*trial_period\\[lt\\] = \"14\"*\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "example" : "14",
            "properties" : {
              "is" : {
                "type" : "string",
                "format" : "number",
                "pattern" : "^-?\\d+$",
                "example" : null
              },
              "is_not" : {
                "type" : "string",
                "format" : "number",
                "pattern" : "^-?\\d+$",
                "example" : null
              },
              "lt" : {
                "type" : "string",
                "format" : "number",
                "pattern" : "^-?\\d+$",
                "example" : null
              },
              "lte" : {
                "type" : "string",
                "format" : "number",
                "pattern" : "^-?\\d+$",
                "example" : null
              },
              "gt" : {
                "type" : "string",
                "format" : "number",
                "pattern" : "^-?\\d+$",
                "example" : null
              },
              "gte" : {
                "type" : "string",
                "format" : "number",
                "pattern" : "^-?\\d+$",
                "example" : null
              },
              "between" : {
                "type" : "string",
                "pattern" : "^\\[-?\\d+,-?\\d+\\]$",
                "example" : null
              },
              "is_present" : {
                "type" : "string",
                "format" : "boolean",
                "enum" : [ "true", "false" ],
                "example" : null
              }
            }
          }
        }, {
          "name" : "trial_period_unit",
          "in" : "query",
          "description" : "optional, enumerated string filter\n\nTime unit for the trial period. Possible values are : day, month.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*trial_period_unit\\[is\\] = \"day\"*\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "example" : "day",
            "properties" : {
              "is" : {
                "type" : "string",
                "description" : "* `day` - In days\n* `month` - In months",
                "enum" : [ "day", "month" ],
                "example" : null
              },
              "is_not" : {
                "type" : "string",
                "description" : "* `day` - In days\n* `month` - In months",
                "enum" : [ "day", "month" ],
                "example" : null
              },
              "in" : {
                "type" : "string",
                "description" : "* `day` - In days\n* `month` - In months",
                "enum" : [ "day", "month" ],
                "pattern" : "^\\[(day|month)(,(day|month))*\\]$",
                "example" : null
              },
              "not_in" : {
                "type" : "string",
                "description" : "* `day` - In days\n* `month` - In months",
                "enum" : [ "day", "month" ],
                "pattern" : "^\\[(day|month)(,(day|month))*\\]$",
                "example" : null
              }
            }
          }
        }, {
          "name" : "addon_applicability",
          "in" : "query",
          "description" : "optional, enumerated string filter\n\nIndicates if all or only some addons are applicable with the plan. Possible values are : all, restricted.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*addon_applicability\\[is\\] = \"all\"*\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "example" : "all",
            "properties" : {
              "is" : {
                "type" : "string",
                "description" : "* `all` - All addons are applicable with this plan.\n* `restricted` - Only addons marked as 'applicable_addons' are applicable with the plan.",
                "enum" : [ "all", "restricted" ],
                "example" : null
              },
              "is_not" : {
                "type" : "string",
                "description" : "* `all` - All addons are applicable with this plan.\n* `restricted` - Only addons marked as 'applicable_addons' are applicable with the plan.",
                "enum" : [ "all", "restricted" ],
                "example" : null
              },
              "in" : {
                "type" : "string",
                "description" : "* `all` - All addons are applicable with this plan.\n* `restricted` - Only addons marked as 'applicable_addons' are applicable with the plan.",
                "enum" : [ "all", "restricted" ],
                "pattern" : "^\\[(all|restricted)(,(all|restricted))*\\]$",
                "example" : null
              },
              "not_in" : {
                "type" : "string",
                "description" : "* `all` - All addons are applicable with this plan.\n* `restricted` - Only addons marked as 'applicable_addons' are applicable with the plan.",
                "enum" : [ "all", "restricted" ],
                "pattern" : "^\\[(all|restricted)(,(all|restricted))*\\]$",
                "example" : null
              }
            }
          }
        }, {
          "name" : "giftable",
          "in" : "query",
          "description" : "optional, boolean filter\n\nSpecifies if the plan should be gifted or not. Possible values are : *true, false*\n\n**Supported operators :**\nis\n\n**Example →**\n*giftable\\[is\\] = \"true\"*\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "example" : "true",
            "properties" : {
              "is" : {
                "type" : "string",
                "format" : "boolean",
                "enum" : [ "true", "false" ],
                "example" : null
              }
            }
          }
        }, {
          "name" : "pricing_model",
          "in" : "query",
          "description" : "optional, enumerated string filter\n\nDefines how the recurring charges for the subscription is calculated. Possible values are : flat_fee, per_unit, tiered, volume, stairstep.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*pricing_model\\[is\\] = \"flat_fee\"*\n",
          "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.\n* `per_unit` - A fixed price per unit quantity.\n* `tiered` - The per unit price is based on the tier that the total quantity falls in.\n* `volume` - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.\n* `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.\n* `per_unit` - A fixed price per unit quantity.\n* `tiered` - The per unit price is based on the tier that the total quantity falls in.\n* `volume` - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.\n* `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.\n* `per_unit` - A fixed price per unit quantity.\n* `tiered` - The per unit price is based on the tier that the total quantity falls in.\n* `volume` - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.\n* `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.\n* `per_unit` - A fixed price per unit quantity.\n* `tiered` - The per unit price is based on the tier that the total quantity falls in.\n* `volume` - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.\n* `stairstep` - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.",
                "enum" : [ "flat_fee", "per_unit", "tiered", "volume", "stairstep" ],
                "pattern" : "^\\[(flat_fee|per_unit|tiered|volume|stairstep)(,(flat_fee|per_unit|tiered|volume|stairstep))*\\]$",
                "example" : null
              }
            }
          }
        }, {
          "name" : "status",
          "in" : "query",
          "description" : "optional, enumerated string filter\n\nThe plan state. Possible values are : active, archived, deleted.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*status\\[is\\] = \"active\"*\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "example" : "active",
            "properties" : {
              "is" : {
                "type" : "string",
                "description" : "* `active` - New subscriptions can be created with the plan.\n* `archived` - No new subscriptions allowed for the plan. Existing subscriptions on this plan will remain as-is and can be migrated to  another active plan if required.\n* `deleted` - Indicates the plan has been deleted.",
                "enum" : [ "active", "archived", "deleted" ],
                "example" : null
              },
              "is_not" : {
                "type" : "string",
                "description" : "* `active` - New subscriptions can be created with the plan.\n* `archived` - No new subscriptions allowed for the plan. Existing subscriptions on this plan will remain as-is and can be migrated to  another active plan if required.\n* `deleted` - Indicates the plan has been deleted.",
                "enum" : [ "active", "archived", "deleted" ],
                "example" : null
              },
              "in" : {
                "type" : "string",
                "description" : "* `active` - New subscriptions can be created with the plan.\n* `archived` - No new subscriptions allowed for the plan. Existing subscriptions on this plan will remain as-is and can be migrated to  another active plan if required.\n* `deleted` - Indicates the plan has been deleted.",
                "enum" : [ "active", "archived", "deleted" ],
                "pattern" : "^\\[(active|archived|deleted)(,(active|archived|deleted))*\\]$",
                "example" : null
              },
              "not_in" : {
                "type" : "string",
                "description" : "* `active` - New subscriptions can be created with the plan.\n* `archived` - No new subscriptions allowed for the plan. Existing subscriptions on this plan will remain as-is and can be migrated to  another active plan if required.\n* `deleted` - Indicates the plan has been deleted.",
                "enum" : [ "active", "archived", "deleted" ],
                "pattern" : "^\\[(active|archived|deleted)(,(active|archived|deleted))*\\]$",
                "example" : null
              }
            }
          }
        }, {
          "name" : "updated_at",
          "in" : "query",
          "description" : "optional, timestamp(UTC) in seconds filter\n\nTo filter based on updated at. This attribute will be present only if the resource has been updated after 2016-11-09.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*updated_at\\[before\\] = \"1243545465\"*\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "example" : "1243545465",
            "properties" : {
              "after" : {
                "type" : "string",
                "format" : "unix-time",
                "pattern" : "^\\d{10}$",
                "example" : null
              },
              "before" : {
                "type" : "string",
                "format" : "unix-time",
                "pattern" : "^\\d{10}$",
                "example" : null
              },
              "on" : {
                "type" : "string",
                "format" : "unix-time",
                "pattern" : "^\\d{10}$",
                "example" : null
              },
              "between" : {
                "type" : "string",
                "pattern" : "^\\[\\d{10},\\d{10}\\]$",
                "example" : null
              }
            }
          }
        }, {
          "name" : "currency_code",
          "in" : "query",
          "description" : "optional, string filter\n\nThe currency code (ISO 4217 format) of the plan.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*currency_code\\[is\\] = \"USD\"*\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "example" : "USD",
            "properties" : {
              "is" : {
                "type" : "string",
                "minLength" : 1,
                "example" : null
              },
              "is_not" : {
                "type" : "string",
                "minLength" : 1,
                "example" : null
              },
              "starts_with" : {
                "type" : "string",
                "minLength" : 1,
                "example" : null
              },
              "in" : {
                "type" : "string",
                "pattern" : "^\\[(.*)(,.*)*\\]$",
                "example" : null
              },
              "not_in" : {
                "type" : "string",
                "pattern" : "^\\[(.*)(,.*)*\\]$",
                "example" : null
              }
            }
          }
        }, {
          "name" : "channel",
          "in" : "query",
          "description" : "optional, enumerated string filter\n\nThe subscription channel this object originated from and is maintained in. Possible values are : web, app_store, play_store.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*channel\\[is\\] = \"APP STORE\"*\n",
          "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" : "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**\n' attribute will be '**true**\n'.\n",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "boolean",
            "default" : false,
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "list" : {
                      "type" : "array",
                      "items" : {
                        "type" : "object",
                        "properties" : {
                          "plan" : {
                            "$ref" : "#/components/schemas/Plan",
                            "description" : "Resource object representing plan"
                          }
                        },
                        "required" : [ "plan" ],
                        "example" : null
                      },
                      "example" : null
                    },
                    "next_offset" : {
                      "type" : "string",
                      "description" : "This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.\n",
                      "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" : [ "plans" ],
        "summary" : "Create a plan",
        "description" : "This endpoint creates a new plan based on the plan Id and plan name.\n",
        "operationId" : "create_a_plan",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "additionalProperties" : true,
                "properties" : {
                  "id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "A unique ID for your system to identify the plan.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "name" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The display name used in web interface for identifying the plan.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "invoice_name" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Display name used in invoice. If it is not configured then name is used in invoice.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "description" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Description about the plan to show in the hosted pages \\& customer portal.\n**Note:**\n\nIf your input contains characters that are subjected to sanitization (like incomplete HTML tags), the sanitization process might increase the length of your input. If the sanitized input exceeds the limit, your request will be rejected.\n",
                    "maxLength" : 2000,
                    "example" : null
                  },
                  "trial_period" : {
                    "type" : "integer",
                    "format" : "int32",
                    "deprecated" : false,
                    "description" : "The free time window for your customer to try your product.\n",
                    "minimum" : 1,
                    "example" : null
                  },
                  "trial_period_unit" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Time unit for the trial period.\n\n* month - In months\n* day - In days\n",
                    "enum" : [ "day", "month" ],
                    "example" : null
                  },
                  "trial_end_action" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Applicable only when [End-of-trial Action](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)\nhas been enabled for the site. Whenever the plan has a trial period, this attribute (parameter) is returned (required) and specifies the operation to be carried out for the subscription once the trial ends. This can be overridden at the [subscription-level](/docs/api/v2/pcv-1/subscriptions/subscription-object#trial_end_action)\n.\n\n* cancel_subscription - The subscription cancels.\n* activate_subscription - The subscription activates and charges are raised for non-metered items.\n* site_default -\n  The action [configured for the site](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)\n  at the time when the trial ends, takes effect.\n",
                    "enum" : [ "site_default", "activate_subscription", "cancel_subscription" ],
                    "example" : null
                  },
                  "period" : {
                    "type" : "integer",
                    "format" : "int32",
                    "default" : 1,
                    "deprecated" : false,
                    "description" : "Defines billing frequency. Example: to bill customer every 3 months, provide \"3\" here.\n",
                    "minimum" : 1,
                    "example" : null
                  },
                  "period_unit" : {
                    "type" : "string",
                    "default" : "month",
                    "deprecated" : false,
                    "description" : "Defines billing frequency in association with billing period.\n\n* month - Charge based on month(s)\n* day - Charge based on day(s)\n* week - Charge based on week(s)\n* year - Charge based on year(s)\n",
                    "enum" : [ "day", "week", "month", "year" ],
                    "example" : null
                  },
                  "setup_cost" : {
                    "type" : "integer",
                    "format" : "int64",
                    "deprecated" : false,
                    "description" : "One-time setup fee charged as part of the first invoice.\n",
                    "minimum" : 1,
                    "example" : null
                  },
                  "price" : {
                    "type" : "integer",
                    "format" : "int64",
                    "deprecated" : false,
                    "description" : "The price of the plan. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                    "minimum" : 0,
                    "example" : null
                  },
                  "price_in_decimal" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The price of the plan when the `pricing_model`\nis `flat_fee`.\nWhen the pricing model is `per_unit`\n, it is the price per unit quantity of the plan. Not applicable for the other pricing models. The value is in decimal and in major units of the currency. Also, this is only applicable when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled. .\n",
                    "maxLength" : 39,
                    "example" : null
                  },
                  "currency_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The currency code (ISO 4217 format) of the plan.\n",
                    "maxLength" : 3,
                    "example" : null
                  },
                  "billing_cycles" : {
                    "type" : "integer",
                    "format" : "int32",
                    "deprecated" : false,
                    "description" : "The number of billing cycles the subscription is active. The subscription is moved to non renewing state and then to cancelled state automatically.\n",
                    "minimum" : 1,
                    "example" : null
                  },
                  "pricing_model" : {
                    "type" : "string",
                    "default" : "flat_fee",
                    "deprecated" : false,
                    "description" : "Defines how the recurring charges for the subscription is calculated.\n\n* tiered - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.\n* per_unit - A fixed price per unit quantity.\n* flat_fee - A fixed price that is not quantity-based.\n* volume - The per unit price is based on the tier that the total quantity falls in.\n* stairstep - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.\n",
                    "enum" : [ "flat_fee", "per_unit", "tiered", "volume", "stairstep" ],
                    "example" : null
                  },
                  "free_quantity" : {
                    "type" : "integer",
                    "format" : "int32",
                    "default" : 0,
                    "deprecated" : false,
                    "description" : "Free quantity the subscriptions of this plan will have. Only the quantity more than this will be charged for the subscription.\n",
                    "minimum" : 0,
                    "example" : null
                  },
                  "free_quantity_in_decimal" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The quantity of the plan that is available free-of-charge, represented in decimal. When a subscription is created for this plan or when the plan of a subscription is changed to this one, only the quantity above this number is charged for. Applicable for quantity-based plans and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled. .\n",
                    "maxLength" : 33,
                    "example" : null
                  },
                  "addon_applicability" : {
                    "type" : "string",
                    "default" : "all",
                    "deprecated" : false,
                    "description" : "Indicates if all or only some addons are applicable with the plan.\n\n* all - All addons are applicable with this plan.\n* restricted - Only addons marked as 'applicable_addons' are applicable with the plan.\n",
                    "enum" : [ "all", "restricted" ],
                    "example" : null
                  },
                  "redirect_url" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The url to redirect on successful checkout. Eg: https://yoursite.com/success.html?plan=basic.\n",
                    "maxLength" : 500,
                    "example" : null
                  },
                  "enabled_in_hosted_pages" : {
                    "type" : "boolean",
                    "default" : true,
                    "deprecated" : false,
                    "description" : "If true, allow checkout through plan specific hosted page URL for this plan.\n",
                    "example" : null
                  },
                  "enabled_in_portal" : {
                    "type" : "boolean",
                    "default" : true,
                    "deprecated" : false,
                    "description" : "If enabled, customers can switch to this plan using the 'Change Subscription' option in the customer portal.\n",
                    "example" : null
                  },
                  "taxable" : {
                    "type" : "boolean",
                    "default" : true,
                    "deprecated" : false,
                    "description" : "Specifies whether taxes apply to this plan. This value is set and returned even if [Taxes](https://www.chargebee.com/docs/tax.html)\nhave been disabled in Chargebee. However, the value is effective only while Taxes are enabled.\n",
                    "example" : null
                  },
                  "tax_profile_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Tax profile of the plan.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "tax_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The Avalara tax codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's [AvaTax for Sales integration](https://www.chargebee.com/docs/avalara.html)\n.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "hsn_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The [HSN code](https://cbic-gst.gov.in/gst-goods-services-rates.html)\nto which the item is mapped for calculating the customer's tax in India. Applicable only when both of the following conditions are true:\n\n* [**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.)\n* The [**AvaTax for Sales** integration](https://www.chargebee.com/docs/avalara.html) has been enabled in Chargebee. .\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "taxjar_product_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The TaxJar product codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's [TaxJar integration](https://www.chargebee.com/docs/taxjar.html)\n.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "avalara_sale_type" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Indicates the type of sale carried out. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)\nintegration.\n\n* retail - Transaction is a sale to an end user\n* vendor_use - Transaction is for an item that is subject to vendor use tax\n* consumed - Transaction is for an item that is consumed directly\n* wholesale - Transaction is a sale to another company that will resell your product or service to another consumer\n",
                    "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)\nintegration.\n",
                    "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)\nintegration.\n",
                    "example" : null
                  },
                  "sku" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The field is used as Product name/code in your third party accounting application. Chargebee will use it as an alternate name in your accounting application.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "accounting_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "This field is to capture the Account code setup in your Accounting system for integration purposes only.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "accounting_category1" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/1.0/finance-integration-index.html )\n\n* [**Xero:**](https://www.chargebee.com/docs/1.0/xero.html ) If you've categorized your products in Xero, provide the category name and option. Use the format: `:` . For example:`Location: Singapore.`\n* [**QuickBooks:**](https://www.chargebee.com/docs/1.0/quickbooks.html ) If you've categorized your product sales in QuickBooks according to Classes, provide the class name here. Use the following format: `::...`\n* [**NetSuite:**](https://www.chargebee.com/docs/1.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.`\n* [**Intacct:**](https://www.chargebee.com/docs/1.0/intacct.html ) If you've classified your products in Intacct under Locations, provide the name of the Location here.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "accounting_category2" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/1.0/finance-integration-index.html )\n\n* [**Xero:**](https://www.chargebee.com/docs/1.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`\n* [**QuickBooks:**](https://www.chargebee.com/docs/1.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`\n* [**NetSuite:**](https://www.chargebee.com/docs/1.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`\n* [**Intacct:**](https://www.chargebee.com/docs/1.0/intacct.html ) If you've classified your products in Intacct under Dimensions, provide the value of the Dimension here.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "accounting_category3" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/1.0/finance-integration-index.html )\n\n* [**NetSuite:**](https://www.chargebee.com/docs/1.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.`\n* [**Intacct:**](https://www.chargebee.com/docs/1.0/intacct.html ) If you've classified your products in Intacct under multiple Dimensions, provide the value of the second Dimension here. .\n",
                    "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 )\n\n* [**NetSuite:**](https://www.chargebee.com/docs/1.0/netsuite.html ) Provide the \"Revenue Recognition Rule Id\" for the product from NetSuite.\n* [**Intacct:**](https://www.chargebee.com/docs/1.0/intacct.html ) If you have configured \"Revenue Recognition Templates\" for products in Intacct, provide the template ID for the product. .\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "is_shippable" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "If enabled, charges for this plan/addon will be added to orders.\n",
                    "example" : null
                  },
                  "shipping_frequency_period" : {
                    "type" : "integer",
                    "format" : "int32",
                    "deprecated" : false,
                    "description" : "Defines the shipping frequency. Example: to bill customer every 2 weeks, provide \"2\" here.\n",
                    "minimum" : 1,
                    "example" : null
                  },
                  "shipping_frequency_period_unit" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Defines the shipping frequency in association with shipping period.\n\n* month - Ship based on month(s)\n* year - Ship based on year(s)\n* day - Ship based on day(s)\n* week - Ship based on week(s)\n",
                    "enum" : [ "year", "month", "week", "day" ],
                    "example" : null
                  },
                  "invoice_notes" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "A customer-facing note added to all invoices associated with this API resource. This note becomes one among [all the notes](/docs/api/invoices/invoice-object#notes)\ndisplayed on the invoice PDF.\n",
                    "maxLength" : 2000,
                    "example" : null
                  },
                  "meta_data" : {
                    "type" : "object",
                    "additionalProperties" : true,
                    "deprecated" : false,
                    "description" : "A collection of key-value pairs that provides extra information about the plan.  \n**Note:**\nThere's a character limit of 65,535.\n\n[Learn more](/docs/api/v2/pcv-1/advanced-features)\n.\n",
                    "example" : null
                  },
                  "show_description_in_invoices" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "Whether the [plan.description](/docs/api/v2/pcv-1/plans/plan-object)\nshould be shown on [invoice PDFs](/docs/api/invoices/retrieve-invoice-as-pdf).\nIf this Boolean is changed, only invoices generated (or [regenerated](https://www.chargebee.com/docs/billing/2.0/invoices-credit-notes-and-quotes/invoice-operations#actions-for-payment-due-not-paid-invoices)\n)after the change are affected; past invoices are not.\n",
                    "example" : null
                  },
                  "show_description_in_quotes" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "Whether the [plan description](/docs/api/v2/pcv-1/plans/plan-object)\nshould be shown on [quote PDFs](/docs/api/quotes/retrieve-quote-as-pdf).\nIf this Boolean is changed, only quotes created after the change are affected; past quotes are not.\n",
                    "example" : null
                  },
                  "giftable" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "Specifies if the plan should be gifted or not.\n",
                    "example" : null
                  },
                  "status" : {
                    "type" : "string",
                    "default" : "active",
                    "deprecated" : false,
                    "description" : "The plan state.\n\n* archived - No new subscriptions allowed for the plan. Existing subscriptions on this plan will remain as-is and can be migrated to another active plan if required.\n* active - New subscriptions can be created with the plan.\n",
                    "enum" : [ "active", "archived" ],
                    "example" : null
                  },
                  "claim_url" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The url to redirect on successful claim. Eg: https://yoursite.com/claim_success.html?plan=basic.\n",
                    "maxLength" : 500,
                    "example" : null
                  },
                  "tiers" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for tiers\n",
                    "properties" : {
                      "starting_unit" : {
                        "type" : "array",
                        "description" : "The lower limit of a range of units for the tier\n",
                        "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\n",
                        "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`\nis `tiered`\nor `volume`\n; the total cost for the item price when the `pricing_model`\nis `stairstep`.\nThe value is in the [minor unit of the currency](/docs/api/v2/pcv-1/currencies)\n.\n",
                        "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`\nof the next lower tier. Applicable only when the `pricing_model`\nis `tiered`\n, `volume`\nor `stairstep`\nand [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis 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. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the `starting_unit_in_decimal`\nof the next higher tier. Applicable only when the `pricing_model`\nis `tiered`\n, `volume`\nor `stairstep`\nand [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis 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 `pricing_model`\nis `tiered`\nor `volume`.\nWhen the `pricing_model`\nis `stairstep`\n, it is the decimal representation of the total price for the plan. The value is in major units of the currency. Applicable when the plan is quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "tax_providers_fields" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for tax_providers_fields\n",
                    "properties" : {
                      "provider_name" : {
                        "type" : "array",
                        "description" : "Name of the tax provider currently supported.\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 us.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "field_value" : {
                        "type" : "array",
                        "description" : "The value of the corresponding tax field.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "required" : [ "field_id", "field_value", "provider_name" ],
                    "example" : null
                  },
                  "applicable_addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for applicable_addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "Identifier of the addon appplicable to the plan.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "event_based_addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for event_based_addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "Identifier of the addon. Multiple addons can be passed.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\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 addon purchased. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 33,
                          "example" : null
                        },
                        "example" : null
                      },
                      "on_event" : {
                        "type" : "array",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "description" : "Event on which the addon will be charged\n\n* plan_activation - Addon will be charged on plan activation.\n* contract_termination - Addon will be charged on contract termination.\n* subscription_activation - Addon will be charged on subscription activation.\n* subscription_creation - Addon will be charged on subscription creation.\n* subscription_trial_start - Addon will be charged when the trial period starts.\n",
                          "enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ],
                          "example" : null
                        },
                        "example" : null
                      },
                      "charge_once" : {
                        "type" : "array",
                        "description" : "If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.\n",
                        "items" : {
                          "type" : "boolean",
                          "default" : true,
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "attached_addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for attached_addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "Identifier of the addon attached with the plan. Only recurring addons can be attached with the plan.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_in_decimal" : {
                        "type" : "array",
                        "description" : "The default quantity of the addon to be attached when the quantity is not specified while [creating](/docs/api/v2/pcv-1/subscriptions/create-a-subscription)\n/ [updating](/docs/api/v2/pcv-1/subscriptions/update-a-subscription)\nthe subscription. The value is in decimal. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 33,
                          "example" : null
                        },
                        "example" : null
                      },
                      "billing_cycles" : {
                        "type" : "array",
                        "description" : "The number of billing cycles this addon will be attached to the plan.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "type" : {
                        "type" : "array",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "description" : "Specifies attachment type of the addon to the plan\n\n* recommended - Addon will be charged with this plan unless specifically removed.\n* mandatory - Addon will be always charged with this plan.\n",
                          "enum" : [ "recommended", "mandatory" ],
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  }
                },
                "required" : [ "id", "name" ],
                "example" : null
              },
              "encoding" : {
                "applicable_addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "attached_addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "event_based_addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "tax_providers_fields" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "tiers" : {
                  "style" : "deepObject",
                  "explode" : true
                }
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "plan" : {
                      "$ref" : "#/components/schemas/Plan",
                      "description" : "Resource object representing plan\n"
                    }
                  },
                  "required" : [ "plan" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/plans/{plan-id}" : {
      "get" : {
        "tags" : [ "plans" ],
        "summary" : "Retrieve a plan",
        "description" : "This endpoint retrieves a specific plan using the plan ID.\n",
        "operationId" : "retrieve_a_plan",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "plan-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/plan-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "plan" : {
                      "$ref" : "#/components/schemas/Plan",
                      "description" : "Resource object representing plan\n"
                    }
                  },
                  "required" : [ "plan" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      },
      "post" : {
        "tags" : [ "plans" ],
        "summary" : "Update a plan",
        "description" : "When updating plans that are already linked to an invoice or a subscription, you can only update the following parameters:\n\n* name\n* invoice_name\n* setup_cost\n* price\n* trial_period\n* trial_period_unit\n* redirect_url\n* enabled_in_hosted_pages\n* meta_data\n",
        "operationId" : "update_a_plan",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "plan-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/plan-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "additionalProperties" : true,
                "properties" : {
                  "name" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The display name used in web interface for identifying the plan.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "invoice_name" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Display name used in invoice. If it is not configured then name is used in invoice.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "description" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Description about the plan to show in the hosted pages \\& customer portal.\n**Note:**\n\nIf your input contains characters that are subjected to sanitization (like incomplete HTML tags), the sanitization process might increase the length of your input. If the sanitized input exceeds the limit, your request will be rejected.\n",
                    "maxLength" : 2000,
                    "example" : null
                  },
                  "trial_period" : {
                    "type" : "integer",
                    "format" : "int32",
                    "deprecated" : false,
                    "description" : "The free time window for your customer to try your product. If **zero**\nis passed, the trial period will be removed.\n",
                    "minimum" : 0,
                    "example" : null
                  },
                  "trial_period_unit" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Time unit for the trial period.\n\n* month - In months\n* day - In days\n",
                    "enum" : [ "day", "month" ],
                    "example" : null
                  },
                  "trial_end_action" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Applicable only when [End-of-trial Action](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)\nhas been enabled for the site. Whenever the plan has a trial period, this attribute (parameter) is returned (required) and specifies the operation to be carried out for the subscription once the trial ends. This can be overridden at the [subscription-level](/docs/api/v2/pcv-1/subscriptions/subscription-object#trial_end_action)\n.\n\n* cancel_subscription - The subscription cancels.\n* activate_subscription - The subscription activates and charges are raised for non-metered items.\n* site_default -\n  The action [configured for the site](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)\n  at the time when the trial ends, takes effect.\n",
                    "enum" : [ "site_default", "activate_subscription", "cancel_subscription" ],
                    "example" : null
                  },
                  "period" : {
                    "type" : "integer",
                    "format" : "int32",
                    "default" : 1,
                    "deprecated" : false,
                    "description" : "Defines billing frequency. Example: to bill customer every 3 months, provide \"3\" here.\n",
                    "minimum" : 1,
                    "example" : null
                  },
                  "period_unit" : {
                    "type" : "string",
                    "default" : "month",
                    "deprecated" : false,
                    "description" : "Defines billing frequency in association with billing period.\n\n* month - Charge based on month(s)\n* day - Charge based on day(s)\n* week - Charge based on week(s)\n* year - Charge based on year(s)\n",
                    "enum" : [ "day", "week", "month", "year" ],
                    "example" : null
                  },
                  "setup_cost" : {
                    "type" : "integer",
                    "format" : "int64",
                    "deprecated" : false,
                    "description" : "One-time setup fee charged as part of the first invoice.\n",
                    "minimum" : 1,
                    "example" : null
                  },
                  "price" : {
                    "type" : "integer",
                    "format" : "int64",
                    "deprecated" : false,
                    "description" : "The price of the plan. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                    "minimum" : 0,
                    "example" : null
                  },
                  "price_in_decimal" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The price of the plan when the `pricing_model`\nis `flat_fee`.\nWhen the pricing model is `per_unit`\n, it is the price per unit quantity of the plan. Not applicable for the other pricing models. The value is in decimal and in major units of the currency. Also, this is only applicable when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled. .\n",
                    "maxLength" : 39,
                    "example" : null
                  },
                  "currency_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The currency code (ISO 4217 format) of the plan. Applicable if Multicurrency is enabled.\n",
                    "maxLength" : 3,
                    "example" : null
                  },
                  "billing_cycles" : {
                    "type" : "integer",
                    "format" : "int32",
                    "deprecated" : false,
                    "description" : "The number of billing cycles the subscription is active. The subscription is moved to non renewing state and then to cancelled state automatically.\n",
                    "minimum" : 1,
                    "example" : null
                  },
                  "pricing_model" : {
                    "type" : "string",
                    "default" : "flat_fee",
                    "deprecated" : false,
                    "description" : "Defines how the recurring charges for the subscription is calculated.\n\n* tiered - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.\n* per_unit - A fixed price per unit quantity.\n* flat_fee - A fixed price that is not quantity-based.\n* volume - The per unit price is based on the tier that the total quantity falls in.\n* stairstep - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.\n",
                    "enum" : [ "flat_fee", "per_unit", "tiered", "volume", "stairstep" ],
                    "example" : null
                  },
                  "free_quantity" : {
                    "type" : "integer",
                    "format" : "int32",
                    "default" : 0,
                    "deprecated" : false,
                    "description" : "Free quantity the subscriptions of this plan will have. Only the quantity more than this will be charged for the subscription.\n",
                    "minimum" : 0,
                    "example" : null
                  },
                  "free_quantity_in_decimal" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The quantity of the plan that is available free-of-charge, represented in decimal. When a subscription is created for this plan or when the plan of a subscription is changed to this one, only the quantity above this number is charged for. Applicable for quantity-based plans and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled. .\n",
                    "maxLength" : 33,
                    "example" : null
                  },
                  "addon_applicability" : {
                    "type" : "string",
                    "default" : "all",
                    "deprecated" : false,
                    "description" : "Indicates if all or only some addons are applicable with the plan.\n\n* all - All addons are applicable with this plan.\n* restricted - Only addons marked as 'applicable_addons' are applicable with the plan.\n",
                    "enum" : [ "all", "restricted" ],
                    "example" : null
                  },
                  "redirect_url" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The url to redirect on successful checkout. Eg: https://yoursite.com/success.html?plan=basic.\n",
                    "maxLength" : 500,
                    "example" : null
                  },
                  "enabled_in_hosted_pages" : {
                    "type" : "boolean",
                    "default" : true,
                    "deprecated" : false,
                    "description" : "If true, allow checkout through plan specific hosted page URL for this plan.\n",
                    "example" : null
                  },
                  "enabled_in_portal" : {
                    "type" : "boolean",
                    "default" : true,
                    "deprecated" : false,
                    "description" : "If enabled, customers can switch to this plan using the 'Change Subscription' option in the customer portal.\n",
                    "example" : null
                  },
                  "taxable" : {
                    "type" : "boolean",
                    "default" : true,
                    "deprecated" : false,
                    "description" : "Specifies whether taxes apply to this plan. This value is set and returned even if [Taxes](https://www.chargebee.com/docs/tax.html)\nhave been disabled in Chargebee. However, the value is effective only while Taxes are enabled.\n",
                    "example" : null
                  },
                  "tax_profile_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Tax profile of the plan.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "tax_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The Avalara tax codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's [AvaTax for Sales integration](https://www.chargebee.com/docs/avalara.html)\n.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "hsn_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The [HSN code](https://cbic-gst.gov.in/gst-goods-services-rates.html)\nto which the item is mapped for calculating the customer's tax in India. Applicable only when both of the following conditions are true:\n\n* [**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.)\n* The [**AvaTax for Sales** integration](https://www.chargebee.com/docs/avalara.html) has been enabled in Chargebee. .\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "taxjar_product_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The TaxJar product codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's [TaxJar integration](https://www.chargebee.com/docs/taxjar.html)\n.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "avalara_sale_type" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Indicates the type of sale carried out. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)\nintegration.\n\n* retail - Transaction is a sale to an end user\n* vendor_use - Transaction is for an item that is subject to vendor use tax\n* consumed - Transaction is for an item that is consumed directly\n* wholesale - Transaction is a sale to another company that will resell your product or service to another consumer\n",
                    "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)\nintegration.\n",
                    "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)\nintegration.\n",
                    "example" : null
                  },
                  "sku" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The field is used as Product name/code in your third party accounting application. Chargebee will use it as an alternate name in your accounting application.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "accounting_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "This field is to capture the Account code setup in your Accounting system for integration purposes only.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "accounting_category1" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/1.0/finance-integration-index.html )\n\n* [**Xero:**](https://www.chargebee.com/docs/1.0/xero.html ) If you've categorized your products in Xero, provide the category name and option. Use the format: `:` . For example:`Location: Singapore.`\n* [**QuickBooks:**](https://www.chargebee.com/docs/1.0/quickbooks.html ) If you've categorized your product sales in QuickBooks according to Classes, provide the class name here. Use the following format: `::...`\n* [**NetSuite:**](https://www.chargebee.com/docs/1.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.`\n* [**Intacct:**](https://www.chargebee.com/docs/1.0/intacct.html ) If you've classified your products in Intacct under Locations, provide the name of the Location here.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "accounting_category2" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/1.0/finance-integration-index.html )\n\n* [**Xero:**](https://www.chargebee.com/docs/1.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`\n* [**QuickBooks:**](https://www.chargebee.com/docs/1.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`\n* [**NetSuite:**](https://www.chargebee.com/docs/1.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`\n* [**Intacct:**](https://www.chargebee.com/docs/1.0/intacct.html ) If you've classified your products in Intacct under Dimensions, provide the value of the Dimension here.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "accounting_category3" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/1.0/finance-integration-index.html )\n\n* [**NetSuite:**](https://www.chargebee.com/docs/1.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.`\n* [**Intacct:**](https://www.chargebee.com/docs/1.0/intacct.html ) If you've classified your products in Intacct under multiple Dimensions, provide the value of the second Dimension here. .\n",
                    "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 )\n\n* [**NetSuite:**](https://www.chargebee.com/docs/1.0/netsuite.html ) Provide the \"Revenue Recognition Rule Id\" for the product from NetSuite.\n* [**Intacct:**](https://www.chargebee.com/docs/1.0/intacct.html ) If you have configured \"Revenue Recognition Templates\" for products in Intacct, provide the template ID for the product. .\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "is_shippable" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "If enabled, charges for this plan/addon will be added to orders.\n",
                    "example" : null
                  },
                  "shipping_frequency_period" : {
                    "type" : "integer",
                    "format" : "int32",
                    "deprecated" : false,
                    "description" : "Defines the shipping frequency. Example: to bill customer every 2 weeks, provide \"2\" here.\n",
                    "minimum" : 1,
                    "example" : null
                  },
                  "shipping_frequency_period_unit" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Defines the shipping frequency in association with shipping period.\n\n* month - Ship based on month(s)\n* year - Ship based on year(s)\n* day - Ship based on day(s)\n* week - Ship based on week(s)\n",
                    "enum" : [ "year", "month", "week", "day" ],
                    "example" : null
                  },
                  "invoice_notes" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "A customer-facing note added to all invoices associated with this API resource. This note becomes one among [all the notes](/docs/api/invoices/invoice-object#notes)\ndisplayed on the invoice PDF.\n",
                    "maxLength" : 2000,
                    "example" : null
                  },
                  "meta_data" : {
                    "type" : "object",
                    "additionalProperties" : true,
                    "deprecated" : false,
                    "description" : "A collection of key-value pairs that provides extra information about the plan.  \n**Note:**\nThere's a character limit of 65,535.\n\n[Learn more](/docs/api/v2/pcv-1/advanced-features)\n.\n",
                    "example" : null
                  },
                  "show_description_in_invoices" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "Whether the [plan.description](/docs/api/v2/pcv-1/plans/plan-object)\nshould be shown on [invoice PDFs](/docs/api/invoices/retrieve-invoice-as-pdf).\nIf this Boolean is changed, only invoices generated (or [regenerated](https://www.chargebee.com/docs/billing/2.0/invoices-credit-notes-and-quotes/invoice-operations#actions-for-payment-due-not-paid-invoices)\n)after the change are affected; past invoices are not.\n",
                    "example" : null
                  },
                  "show_description_in_quotes" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "Whether the [plan description](/docs/api/v2/pcv-1/plans/plan-object)\nshould be shown on [quote PDFs](/docs/api/quotes/retrieve-quote-as-pdf).\nIf this Boolean is changed, only quotes created after the change are affected; past quotes are not.\n",
                    "example" : null
                  },
                  "tiers" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for tiers\n",
                    "properties" : {
                      "starting_unit" : {
                        "type" : "array",
                        "description" : "The lower limit of a range of units for the tier\n",
                        "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\n",
                        "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`\nis `tiered`\nor `volume`\n; the total cost for the item price when the `pricing_model`\nis `stairstep`.\nThe value is in the [minor unit of the currency](/docs/api/v2/pcv-1/currencies)\n.\n",
                        "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`\nof the next lower tier. Applicable only when the `pricing_model`\nis `tiered`\n, `volume`\nor `stairstep`\nand [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis 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. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the `starting_unit_in_decimal`\nof the next higher tier. Applicable only when the `pricing_model`\nis `tiered`\n, `volume`\nor `stairstep`\nand [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis 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 `pricing_model`\nis `tiered`\nor `volume`.\nWhen the `pricing_model`\nis `stairstep`\n, it is the decimal representation of the total price for the plan. The value is in major units of the currency. Applicable when the plan is quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "tax_providers_fields" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for tax_providers_fields\n",
                    "properties" : {
                      "provider_name" : {
                        "type" : "array",
                        "description" : "Name of the tax provider currently supported.\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 us.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "field_value" : {
                        "type" : "array",
                        "description" : "The value of the corresponding tax field.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "required" : [ "field_id", "field_value", "provider_name" ],
                    "example" : null
                  },
                  "applicable_addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for applicable_addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "Identifier of the addon appplicable to the plan.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "event_based_addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for event_based_addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "Identifier of the addon. Multiple addons can be passed.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\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 addon purchased. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 33,
                          "example" : null
                        },
                        "example" : null
                      },
                      "on_event" : {
                        "type" : "array",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "description" : "Event on which the addon will be charged\n\n* plan_activation - Addon will be charged on plan activation.\n* contract_termination - Addon will be charged on contract termination.\n* subscription_activation - Addon will be charged on subscription activation.\n* subscription_creation - Addon will be charged on subscription creation.\n* subscription_trial_start - Addon will be charged when the trial period starts.\n",
                          "enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ],
                          "example" : null
                        },
                        "example" : null
                      },
                      "charge_once" : {
                        "type" : "array",
                        "description" : "If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.\n",
                        "items" : {
                          "type" : "boolean",
                          "default" : true,
                          "deprecated" : false,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "attached_addons" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for attached_addons\n",
                    "properties" : {
                      "id" : {
                        "type" : "array",
                        "description" : "Identifier of the addon attached with the plan. Only recurring addons can be attached with the plan.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 100,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "array",
                        "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "quantity_in_decimal" : {
                        "type" : "array",
                        "description" : "The default quantity of the addon to be attached when the quantity is not specified while [creating](/docs/api/v2/pcv-1/subscriptions/create-a-subscription)\n/ [updating](/docs/api/v2/pcv-1/subscriptions/update-a-subscription)\nthe subscription. The value is in decimal. Can be provided for quantity-based addons and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 33,
                          "example" : null
                        },
                        "example" : null
                      },
                      "billing_cycles" : {
                        "type" : "array",
                        "description" : "The number of billing cycles this addon will be attached to the plan.\n",
                        "items" : {
                          "type" : "integer",
                          "format" : "int32",
                          "deprecated" : false,
                          "minimum" : 1,
                          "example" : null
                        },
                        "example" : null
                      },
                      "type" : {
                        "type" : "array",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "description" : "Specifies attachment type of the addon to the plan\n\n* recommended - Addon will be charged with this plan unless specifically removed.\n* mandatory - Addon will be always charged with this plan.\n",
                          "enum" : [ "recommended", "mandatory" ],
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  }
                },
                "example" : null
              },
              "encoding" : {
                "applicable_addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "attached_addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "event_based_addons" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "tax_providers_fields" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "tiers" : {
                  "style" : "deepObject",
                  "explode" : true
                }
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "plan" : {
                      "$ref" : "#/components/schemas/Plan",
                      "description" : "Resource object representing plan\n"
                    }
                  },
                  "required" : [ "plan" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/addons/copy" : {
      "post" : {
        "tags" : [ "addons" ],
        "summary" : "Copy an addon",
        "description" : "Creates an addon in this site by copying its configurations from another site. Copying of archived addons is not supported.  \n**Note:**\nThe attribute *tax_profile_id*\nis not copied. In effect, if the plan is taxable, it will be mapped to the *Primary*\ntax profile.\n",
        "operationId" : "copy_an_addon",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "from_site" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Your Chargebee site name having the addon to be copied.\n**Note:**\nUnless 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)\nto have this allow-listed.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "id_at_from_site" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Id of the addon to be copied. The new addon created in this site will have the same Id.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Id of copied addon in this site.\n",
                    "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.\n",
                    "example" : null
                  }
                },
                "required" : [ "from_site", "id_at_from_site" ],
                "example" : null
              },
              "encoding" : { }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "addon" : {
                      "$ref" : "#/components/schemas/Addon",
                      "description" : "Resource object representing addon\n"
                    }
                  },
                  "required" : [ "addon" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/addons/{addon-id}/unarchive" : {
      "post" : {
        "tags" : [ "addons" ],
        "summary" : "Unarchive an addon",
        "description" : "Unarchives a specific addon using the id.\n",
        "operationId" : "unarchive_an_addon",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "addon-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/addon-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "addon" : {
                      "$ref" : "#/components/schemas/Addon",
                      "description" : "Resource object representing addon\n"
                    }
                  },
                  "required" : [ "addon" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/addons/{addon-id}" : {
      "get" : {
        "tags" : [ "addons" ],
        "summary" : "Retrieve an addon",
        "description" : "Retrieve a specific addon using the ID.\n",
        "operationId" : "retrieve_an_addon",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "addon-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/addon-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "addon" : {
                      "$ref" : "#/components/schemas/Addon",
                      "description" : "Resource object representing addon\n"
                    }
                  },
                  "required" : [ "addon" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      },
      "post" : {
        "tags" : [ "addons" ],
        "summary" : "Update an addon",
        "description" : "When updating addons that already have an invoice or a subscription linked to it, you can only update the following parameters:\n\n* name\n* invoice_name\n* price\n* included_in_mrr\n* meta_data\n",
        "operationId" : "update_an_addon",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "addon-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/addon-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "additionalProperties" : true,
                "properties" : {
                  "name" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The display name used in web interface for identifying the addon.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "invoice_name" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Display name used in invoice. If it is not configured then name is used in invoice.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "description" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Description about the addon to show in the hosted pages \\& customer portal. This description will not be shown if multiple addons are added.\n**Note:**\n\nIf your input contains characters that are subjected to sanitization (like incomplete HTML tags), the sanitization process might increase the length of your input. If the sanitized input exceeds the limit, your request will be rejected.\n",
                    "maxLength" : 2000,
                    "example" : null
                  },
                  "charge_type" : {
                    "type" : "string",
                    "default" : "recurring",
                    "deprecated" : false,
                    "description" : "Type of charge.\n\n* non_recurring - Charged immediately and only once every time it is applied.\n* recurring - Charges are automatically applied in sync with the billing frequency of subscription.\n",
                    "enum" : [ "recurring", "non_recurring" ],
                    "example" : null
                  },
                  "price" : {
                    "type" : "integer",
                    "format" : "int64",
                    "deprecated" : false,
                    "description" : "Addon price is calculated based on the addon type and charge type. [Learn more](https://www.chargebee.com/docs/addons.html#charge-type-and-pricing).\nThe unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                    "minimum" : 0,
                    "example" : null
                  },
                  "currency_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The currency code (ISO 4217 format) of the addon. Applicable if Multicurrency is enabled.\n",
                    "maxLength" : 3,
                    "example" : null
                  },
                  "period" : {
                    "type" : "integer",
                    "format" : "int32",
                    "deprecated" : false,
                    "description" : "Applicable only for recurring-addons. Along with 'period_unit' decides the term-price of this addon.\n",
                    "minimum" : 1,
                    "example" : null
                  },
                  "period_unit" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Applicable only for recurring-addons. Along with 'period' decides the term-price of this addon.\n\n* month - Charge based on month(s)\n* week - Charge based on week(s)\n* not_applicable - not applicable for this addon\n* year - Charge based on year(s)\n* day - Charge based on Day(S)\n",
                    "enum" : [ "day", "week", "month", "year", "not_applicable" ],
                    "example" : null
                  },
                  "pricing_model" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Defines how the charges for the addons are calculated.\n\n* tiered - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.\n* per_unit - A fixed price per unit quantity.\n* flat_fee - A fixed price that is not quantity-based.\n* volume - The per unit price is based on the tier that the total quantity falls in.\n* stairstep - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.\n",
                    "enum" : [ "flat_fee", "per_unit", "tiered", "volume", "stairstep" ],
                    "example" : null
                  },
                  "unit" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Specifies the type of quantity. For example, if the addon price is $10 and 'agent' is the unit of measure, the addon will be $10/agent.\nApplicable only for quantity type addons.\n",
                    "maxLength" : 30,
                    "example" : null
                  },
                  "enabled_in_portal" : {
                    "type" : "boolean",
                    "default" : true,
                    "deprecated" : false,
                    "description" : "If enabled, customers can select this addon using the 'Change Subscription' option in the customer portal.\n",
                    "example" : null
                  },
                  "taxable" : {
                    "type" : "boolean",
                    "default" : true,
                    "deprecated" : false,
                    "description" : "Specifies whether taxes apply to this addon. This value is set and returned even if [Taxes](https://www.chargebee.com/docs/tax.html)\nhave been disabled in Chargebee. However, the value is effective only while Taxes are enabled.\n",
                    "example" : null
                  },
                  "tax_profile_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Tax profile of the addon.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "avalara_sale_type" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Indicates the type of sale carried out. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)\nintegration.\n\n* retail - Transaction is a sale to an end user\n* vendor_use - Transaction is for an item that is subject to vendor use tax\n* wholesale - Transaction is a sale to another company that will resell your product or service to another consumer\n* consumed - Transaction is for an item that is consumed directly\n",
                    "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)\nintegration.\n",
                    "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)\nintegration.\n",
                    "example" : null
                  },
                  "tax_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The Avalara tax codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's [AvaTax for Sales integration](https://www.chargebee.com/docs/avalara.html)\n.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "hsn_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The [HSN code](https://cbic-gst.gov.in/gst-goods-services-rates.html)\nto which the item is mapped for calculating the customer's tax in India. Applicable only when both of the following conditions are true:\n\n* [**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.)\n* The [**AvaTax for Sales** integration](https://www.chargebee.com/docs/avalara.html) has been enabled in Chargebee.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "taxjar_product_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The TaxJar product codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's [TaxJar integration](https://www.chargebee.com/docs/taxjar.html)\n.\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)\ndisplayed on the invoice PDF.\n",
                    "maxLength" : 2000,
                    "example" : null
                  },
                  "meta_data" : {
                    "type" : "object",
                    "additionalProperties" : true,
                    "deprecated" : false,
                    "description" : "A collection of key-value pairs that provides extra information about the addon.  \n**Note:**\nThere's a character limit of 65,535.\n\n[Learn more](/docs/api/v2/pcv-1/advanced-features)\n.\n",
                    "example" : null
                  },
                  "sku" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The field is used as Product name/code in your third party accounting application. Chargebee will use it as an alternate name in your accounting application.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "accounting_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "This field is to capture the Account code setup in your Accounting system for integration purposes only.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "accounting_category1" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/1.0/finance-integration-index.html )\n\n* [**Xero:**](https://www.chargebee.com/docs/1.0/xero.html ) If you've categorized your products in Xero, provide the category name and option. Use the format: `:` . For example:`Location: Singapore.`\n* [**QuickBooks:**](https://www.chargebee.com/docs/1.0/quickbooks.html ) If you've categorized your product sales in QuickBooks according to Classes, provide the class name here. Use the following format: `::...`\n* [**NetSuite:**](https://www.chargebee.com/docs/1.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.`\n* [**Intacct:**](https://www.chargebee.com/docs/1.0/intacct.html ) If you've classified your products in Intacct under Locations, provide the name of the Location here.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "accounting_category2" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/1.0/finance-integration-index.html )\n\n* [**Xero:**](https://www.chargebee.com/docs/1.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`\n* [**QuickBooks:**](https://www.chargebee.com/docs/1.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`\n* [**NetSuite:**](https://www.chargebee.com/docs/1.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`\n* [**Intacct:**](https://www.chargebee.com/docs/1.0/intacct.html ) If you've classified your products in Intacct under Dimensions, provide the value of the Dimension here.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "accounting_category3" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/1.0/finance-integration-index.html )\n\n* [**NetSuite:**](https://www.chargebee.com/docs/1.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.`\n* [**Intacct:**](https://www.chargebee.com/docs/1.0/intacct.html ) If you've classified your products in Intacct under multiple Dimensions, provide the value of the second Dimension here. .\n",
                    "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 )\n\n* [**NetSuite:**](https://www.chargebee.com/docs/1.0/netsuite.html ) Provide the \"Revenue Recognition Rule Id\" for the product from NetSuite.\n* [**Intacct:**](https://www.chargebee.com/docs/1.0/intacct.html ) If you have configured \"Revenue Recognition Templates\" for products in Intacct, provide the template ID for the product. .\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "is_shippable" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "If enabled, charges for this plan/addon will be added to orders.\n",
                    "example" : null
                  },
                  "shipping_frequency_period" : {
                    "type" : "integer",
                    "format" : "int32",
                    "deprecated" : false,
                    "description" : "Defines the shipping frequency. Example: to bill customer every 2 weeks, provide \"2\" here.\n",
                    "minimum" : 1,
                    "example" : null
                  },
                  "shipping_frequency_period_unit" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Defines the shipping frequency in association with shipping period.\n\n* day - Ship based on day(s)\n* week - Ship based on week(s)\n* month - Ship based on month(s)\n* year - Ship based on year(s)\n",
                    "enum" : [ "year", "month", "week", "day" ],
                    "example" : null
                  },
                  "included_in_mrr" : {
                    "type" : "boolean",
                    "deprecated" : false,
                    "description" : "The addon is included in MRR calculations for your site. This attribute is only applicable for addons of `charge_type = non_recurring`\nand when the feature is enabled in Chargebee. Note: If the site-level setting is to exclude non-recurring addons from MRR calculations, this value is always returned `false`\n.\n",
                    "example" : null
                  },
                  "show_description_in_invoices" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "Whether the [addon description](/docs/api/v2/pcv-1/addons/addon-object)\nshould be shown on [invoice PDFs](/docs/api/invoices/retrieve-invoice-as-pdf).\nIf 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)\n) after the change are affected; past invoices are not.\n",
                    "example" : null
                  },
                  "show_description_in_quotes" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "Whether the [addon description](/docs/api/v2/pcv-1/addons/addon-object)\nshould be shown on [quote PDFs](/docs/api/quotes/retrieve-quote-as-pdf).\nIf this Boolean is changed, only quotes created after the change are affected; past quotes are not.\n",
                    "example" : null
                  },
                  "price_in_decimal" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The price of the addon when the `pricing_model`\nis `flat_fee`.\nWhen the pricing model is `per_unit`\n, 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/v2/pcv-1/currencies)\nis enabled.\n\nThis price is for the `period` of the addon. When attached to a plan, the addon is billed for the billing period of the plan. Learn more.\n",
                    "maxLength" : 39,
                    "example" : null
                  },
                  "proration_type" : {
                    "type" : "string",
                    "default" : "site_default",
                    "deprecated" : false,
                    "description" : "**Note**\nApplicable only for addons with [pricing_model](/docs/api/v2/pcv-1/addons/addon-object#pricing_model) = `per_unit`.\n\nSpecifies how to manage charges or credits for the addon during a [subscription update](/docs/api/v2/pcv-1/subscriptions/update-a-subscription)\nor [estimating](/docs/api/v2/pcv-1/estimates/update-subscription-estimate)\na subscription update.\n\n* full_term - Charge the full price of the addon item price or give the full credit. Don't apply any proration.\n* site_default -\n  Use the [site-wide proration setting](https://www.chargebee.com/docs/1.0/proration.html#proration-for-subscription-change)\n  .\n* partial_term - Prorate the charges or credits for the rest of the current term.\n",
                    "enum" : [ "site_default", "partial_term", "full_term" ],
                    "example" : null
                  },
                  "tiers" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for tiers\n",
                    "properties" : {
                      "starting_unit" : {
                        "type" : "array",
                        "description" : "The lower limit of a range of units for the tier\n",
                        "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\n",
                        "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`\nis `tiered`\nor `volume`\n; the total cost for the item price when the `pricing_model`\nis `stairstep`.\nThe value is in the [minor unit of the currency](/docs/api/v2/pcv-1/currencies)\n.\n",
                        "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`\nof the next lower tier. Applicable only when the `pricing_model`\nis `tiered`\n, `volume`\nor `stairstep`\nand [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis 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. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the `starting_unit_in_decimal`\nof the next higher tier. Applicable only when the `pricing_model`\nis `tiered`\n, `volume`\nor `stairstep`\nand [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis 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 `pricing_model`\nis `tiered`\nor `volume`.\nWhen the `pricing_model`\nis `stairstep`\n, it is the decimal representation of the total price for the plan. The value is in major units of the currency. Applicable when the plan is quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "tax_providers_fields" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for tax_providers_fields\n",
                    "properties" : {
                      "provider_name" : {
                        "type" : "array",
                        "description" : "Name of the tax provider currently supported.\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 us.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "field_value" : {
                        "type" : "array",
                        "description" : "The value of the corresponding tax field.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "required" : [ "field_id", "field_value", "provider_name" ],
                    "example" : null
                  }
                },
                "example" : null
              },
              "encoding" : {
                "tax_providers_fields" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "tiers" : {
                  "style" : "deepObject",
                  "explode" : true
                }
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "addon" : {
                      "$ref" : "#/components/schemas/Addon",
                      "description" : "Resource object representing addon\n"
                    }
                  },
                  "required" : [ "addon" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/addons" : {
      "get" : {
        "tags" : [ "addons" ],
        "summary" : "List addons",
        "description" : "List the addons. This returns all your current active and archived addons.\n",
        "operationId" : "list_addons",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "limit",
          "in" : "query",
          "description" : "The number of resources to be returned.\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`\nto the value of `next_offset`\nobtained in the previous iteration of the API call.\n",
          "required" : false,
          "deprecated" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "maxLength" : 1000,
            "example" : null
          }
        }, {
          "name" : "id",
          "in" : "query",
          "description" : "optional, string filter\n\nA unique ID for your system to identify the addon.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*id\\[is\\] = \"support_charge\"*\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "example" : "support_charge",
            "properties" : {
              "is" : {
                "type" : "string",
                "minLength" : 1,
                "example" : null
              },
              "is_not" : {
                "type" : "string",
                "minLength" : 1,
                "example" : null
              },
              "starts_with" : {
                "type" : "string",
                "minLength" : 1,
                "example" : null
              },
              "in" : {
                "type" : "string",
                "pattern" : "^\\[(.*)(,.*)*\\]$",
                "example" : null
              },
              "not_in" : {
                "type" : "string",
                "pattern" : "^\\[(.*)(,.*)*\\]$",
                "example" : null
              }
            }
          }
        }, {
          "name" : "name",
          "in" : "query",
          "description" : "optional, string filter\n\nThe display name used in web interface for identifying the addon.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*name\\[is\\] = \"Support Charge\"*\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "example" : "Support Charge",
            "properties" : {
              "is" : {
                "type" : "string",
                "minLength" : 1,
                "example" : null
              },
              "is_not" : {
                "type" : "string",
                "minLength" : 1,
                "example" : null
              },
              "starts_with" : {
                "type" : "string",
                "minLength" : 1,
                "example" : null
              },
              "in" : {
                "type" : "string",
                "pattern" : "^\\[(.*)(,.*)*\\]$",
                "example" : null
              },
              "not_in" : {
                "type" : "string",
                "pattern" : "^\\[(.*)(,.*)*\\]$",
                "example" : null
              }
            }
          }
        }, {
          "name" : "pricing_model",
          "in" : "query",
          "description" : "optional, enumerated string filter\n\nDefines how the charges for the addons are calculated. Possible values are : flat_fee, per_unit, tiered, volume, stairstep.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*pricing_model\\[is\\] = \"flat_fee\"*\n",
          "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.\n* `per_unit` - A fixed price per unit quantity.\n* `tiered` - The per unit price is based on the tier that the total quantity falls in.\n* `volume` - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.\n* `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.\n* `per_unit` - A fixed price per unit quantity.\n* `tiered` - The per unit price is based on the tier that the total quantity falls in.\n* `volume` - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.\n* `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.\n* `per_unit` - A fixed price per unit quantity.\n* `tiered` - The per unit price is based on the tier that the total quantity falls in.\n* `volume` - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.\n* `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.\n* `per_unit` - A fixed price per unit quantity.\n* `tiered` - The per unit price is based on the tier that the total quantity falls in.\n* `volume` - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.\n* `stairstep` - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.",
                "enum" : [ "flat_fee", "per_unit", "tiered", "volume", "stairstep" ],
                "pattern" : "^\\[(flat_fee|per_unit|tiered|volume|stairstep)(,(flat_fee|per_unit|tiered|volume|stairstep))*\\]$",
                "example" : null
              }
            }
          }
        }, {
          "name" : "charge_type",
          "in" : "query",
          "description" : "optional, enumerated string filter\n\nType of charge. Possible values are : recurring, non_recurring.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*charge_type\\[is_not\\] = \"recurring\"*\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "example" : "recurring",
            "properties" : {
              "is" : {
                "type" : "string",
                "description" : "* `recurring` - Charges are automatically applied in sync with the billing frequency of subscription.\n* `non_recurring` - Charged immediately and only once every time it is applied.",
                "enum" : [ "recurring", "non_recurring" ],
                "example" : null
              },
              "is_not" : {
                "type" : "string",
                "description" : "* `recurring` - Charges are automatically applied in sync with the billing frequency of subscription.\n* `non_recurring` - Charged immediately and only once every time it is applied.",
                "enum" : [ "recurring", "non_recurring" ],
                "example" : null
              },
              "in" : {
                "type" : "string",
                "description" : "* `recurring` - Charges are automatically applied in sync with the billing frequency of subscription.\n* `non_recurring` - Charged immediately and only once every time it is applied.",
                "enum" : [ "recurring", "non_recurring" ],
                "pattern" : "^\\[(recurring|non_recurring)(,(recurring|non_recurring))*\\]$",
                "example" : null
              },
              "not_in" : {
                "type" : "string",
                "description" : "* `recurring` - Charges are automatically applied in sync with the billing frequency of subscription.\n* `non_recurring` - Charged immediately and only once every time it is applied.",
                "enum" : [ "recurring", "non_recurring" ],
                "pattern" : "^\\[(recurring|non_recurring)(,(recurring|non_recurring))*\\]$",
                "example" : null
              }
            }
          }
        }, {
          "name" : "price",
          "in" : "query",
          "description" : "optional, in cents filter\n\nAddon price is calculated based on the addon type and charge type. [Learn more](https://www.chargebee.com/docs/addons.html#charge-type-and-pricing).\nThe unit depends on the [type of currency](/docs/api/getting-started)\n.\n**Supported operators :**\nis, is_not, lt, lte, gt, gte, between\n\n**Example →**\n*price\\[gte\\] = \"1300\"*\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "example" : "1300",
            "properties" : {
              "is" : {
                "type" : "string",
                "format" : "number",
                "pattern" : "^-?\\d+$",
                "example" : null
              },
              "is_not" : {
                "type" : "string",
                "format" : "number",
                "pattern" : "^-?\\d+$",
                "example" : null
              },
              "lt" : {
                "type" : "string",
                "format" : "number",
                "pattern" : "^-?\\d+$",
                "example" : null
              },
              "lte" : {
                "type" : "string",
                "format" : "number",
                "pattern" : "^-?\\d+$",
                "example" : null
              },
              "gt" : {
                "type" : "string",
                "format" : "number",
                "pattern" : "^-?\\d+$",
                "example" : null
              },
              "gte" : {
                "type" : "string",
                "format" : "number",
                "pattern" : "^-?\\d+$",
                "example" : null
              },
              "between" : {
                "type" : "string",
                "pattern" : "^\\[-?\\d+,-?\\d+\\]$",
                "example" : null
              }
            }
          }
        }, {
          "name" : "period",
          "in" : "query",
          "description" : "optional, integer filter\n\nApplicable only for recurring-addons. Along with 'period_unit' decides the term-price of this addon.\n**Supported operators :**\nis, is_not, lt, lte, gt, gte, between\n\n**Example →**\n*period\\[is\\] = \"3\"*\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "example" : "3",
            "properties" : {
              "is" : {
                "type" : "string",
                "format" : "number",
                "pattern" : "^-?\\d+$",
                "example" : null
              },
              "is_not" : {
                "type" : "string",
                "format" : "number",
                "pattern" : "^-?\\d+$",
                "example" : null
              },
              "lt" : {
                "type" : "string",
                "format" : "number",
                "pattern" : "^-?\\d+$",
                "example" : null
              },
              "lte" : {
                "type" : "string",
                "format" : "number",
                "pattern" : "^-?\\d+$",
                "example" : null
              },
              "gt" : {
                "type" : "string",
                "format" : "number",
                "pattern" : "^-?\\d+$",
                "example" : null
              },
              "gte" : {
                "type" : "string",
                "format" : "number",
                "pattern" : "^-?\\d+$",
                "example" : null
              },
              "between" : {
                "type" : "string",
                "pattern" : "^\\[-?\\d+,-?\\d+\\]$",
                "example" : null
              }
            }
          }
        }, {
          "name" : "period_unit",
          "in" : "query",
          "description" : "optional, enumerated string filter\n\nApplicable only for recurring-addons. Along with 'period' decides the term-price of this addon. Possible values are : day, week, month, year, not_applicable.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*period_unit\\[is_not\\] = \"month\"*\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "example" : "month",
            "properties" : {
              "is" : {
                "type" : "string",
                "description" : "* `day` - Charge based on Day(S)\n* `week` - Charge based on week(s)\n* `month` - Charge based on month(s)\n* `year` - Charge based on year(s)\n* `not_applicable` - not applicable for this addon",
                "enum" : [ "day", "week", "month", "year", "not_applicable" ],
                "example" : null
              },
              "is_not" : {
                "type" : "string",
                "description" : "* `day` - Charge based on Day(S)\n* `week` - Charge based on week(s)\n* `month` - Charge based on month(s)\n* `year` - Charge based on year(s)\n* `not_applicable` - not applicable for this addon",
                "enum" : [ "day", "week", "month", "year", "not_applicable" ],
                "example" : null
              },
              "in" : {
                "type" : "string",
                "description" : "* `day` - Charge based on Day(S)\n* `week` - Charge based on week(s)\n* `month` - Charge based on month(s)\n* `year` - Charge based on year(s)\n* `not_applicable` - not applicable for this addon",
                "enum" : [ "day", "week", "month", "year", "not_applicable" ],
                "pattern" : "^\\[(day|week|month|year|not_applicable)(,(day|week|month|year|not_applicable))*\\]$",
                "example" : null
              },
              "not_in" : {
                "type" : "string",
                "description" : "* `day` - Charge based on Day(S)\n* `week` - Charge based on week(s)\n* `month` - Charge based on month(s)\n* `year` - Charge based on year(s)\n* `not_applicable` - not applicable for this addon",
                "enum" : [ "day", "week", "month", "year", "not_applicable" ],
                "pattern" : "^\\[(day|week|month|year|not_applicable)(,(day|week|month|year|not_applicable))*\\]$",
                "example" : null
              }
            }
          }
        }, {
          "name" : "status",
          "in" : "query",
          "description" : "optional, enumerated string filter\n\nStatus of the addon. Possible values are : active, archived, deleted.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*status\\[is_not\\] = \"active\"*\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "example" : "active",
            "properties" : {
              "is" : {
                "type" : "string",
                "description" : "* `active` - Only active addons can be applied to subscriptions\n* `archived` - No new associations with subscriptions are allowed. Existing associations for recurring addons remain as-is and can be removed if required.\n* `deleted` - Indicates the addon has been deleted.",
                "enum" : [ "active", "archived", "deleted" ],
                "example" : null
              },
              "is_not" : {
                "type" : "string",
                "description" : "* `active` - Only active addons can be applied to subscriptions\n* `archived` - No new associations with subscriptions are allowed. Existing associations for recurring addons remain as-is and can be removed if required.\n* `deleted` - Indicates the addon has been deleted.",
                "enum" : [ "active", "archived", "deleted" ],
                "example" : null
              },
              "in" : {
                "type" : "string",
                "description" : "* `active` - Only active addons can be applied to subscriptions\n* `archived` - No new associations with subscriptions are allowed. Existing associations for recurring addons remain as-is and can be removed if required.\n* `deleted` - Indicates the addon has been deleted.",
                "enum" : [ "active", "archived", "deleted" ],
                "pattern" : "^\\[(active|archived|deleted)(,(active|archived|deleted))*\\]$",
                "example" : null
              },
              "not_in" : {
                "type" : "string",
                "description" : "* `active` - Only active addons can be applied to subscriptions\n* `archived` - No new associations with subscriptions are allowed. Existing associations for recurring addons remain as-is and can be removed if required.\n* `deleted` - Indicates the addon has been deleted.",
                "enum" : [ "active", "archived", "deleted" ],
                "pattern" : "^\\[(active|archived|deleted)(,(active|archived|deleted))*\\]$",
                "example" : null
              }
            }
          }
        }, {
          "name" : "updated_at",
          "in" : "query",
          "description" : "optional, timestamp(UTC) in seconds filter\n\nTo filter based on updated at. This attribute will be present only if the resource has been updated after 2016-11-09.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*updated_at\\[on\\] = \"1243545465\"*\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "example" : "1243545465",
            "properties" : {
              "after" : {
                "type" : "string",
                "format" : "unix-time",
                "pattern" : "^\\d{10}$",
                "example" : null
              },
              "before" : {
                "type" : "string",
                "format" : "unix-time",
                "pattern" : "^\\d{10}$",
                "example" : null
              },
              "on" : {
                "type" : "string",
                "format" : "unix-time",
                "pattern" : "^\\d{10}$",
                "example" : null
              },
              "between" : {
                "type" : "string",
                "pattern" : "^\\[\\d{10},\\d{10}\\]$",
                "example" : null
              }
            }
          }
        }, {
          "name" : "currency_code",
          "in" : "query",
          "description" : "optional, string filter\n\nThe currency code (ISO 4217 format) of the addon.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*currency_code\\[is\\] = \"USD\"*\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "example" : "USD",
            "properties" : {
              "is" : {
                "type" : "string",
                "minLength" : 1,
                "example" : null
              },
              "is_not" : {
                "type" : "string",
                "minLength" : 1,
                "example" : null
              },
              "starts_with" : {
                "type" : "string",
                "minLength" : 1,
                "example" : null
              },
              "in" : {
                "type" : "string",
                "pattern" : "^\\[(.*)(,.*)*\\]$",
                "example" : null
              },
              "not_in" : {
                "type" : "string",
                "pattern" : "^\\[(.*)(,.*)*\\]$",
                "example" : null
              }
            }
          }
        }, {
          "name" : "channel",
          "in" : "query",
          "description" : "optional, enumerated string filter\n\nThe subscription channel this object originated from and is maintained in. Possible values are : web, app_store, play_store.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*channel\\[is\\] = \"APP STORE\"*\n",
          "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" : "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**\n' attribute will be '**true**\n'.\n",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "boolean",
            "default" : false,
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "list" : {
                      "type" : "array",
                      "items" : {
                        "type" : "object",
                        "properties" : {
                          "addon" : {
                            "$ref" : "#/components/schemas/Addon",
                            "description" : "Resource object representing addon"
                          }
                        },
                        "required" : [ "addon" ],
                        "example" : null
                      },
                      "example" : null
                    },
                    "next_offset" : {
                      "type" : "string",
                      "description" : "This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.\n",
                      "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" : [ "addons" ],
        "summary" : "Create an addon",
        "description" : "Create a new addon.\n",
        "operationId" : "create_an_addon",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "additionalProperties" : true,
                "properties" : {
                  "id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "A unique ID for your system to identify the addon.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "name" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The display name used in web interface for identifying the addon.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "invoice_name" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Display name used in invoice. If it is not configured then name is used in invoice.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "description" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Description about the addon to show in the hosted pages \\& customer portal. This description will not be shown if multiple addons are added.\n**Note:**\n\nIf your input contains characters that are subjected to sanitization (like incomplete HTML tags), the sanitization process might increase the length of your input. If the sanitized input exceeds the limit, your request will be rejected.\n",
                    "maxLength" : 2000,
                    "example" : null
                  },
                  "charge_type" : {
                    "type" : "string",
                    "default" : "recurring",
                    "deprecated" : false,
                    "description" : "Type of charge.\n\n* non_recurring - Charged immediately and only once every time it is applied.\n* recurring - Charges are automatically applied in sync with the billing frequency of subscription.\n",
                    "enum" : [ "recurring", "non_recurring" ],
                    "example" : null
                  },
                  "price" : {
                    "type" : "integer",
                    "format" : "int64",
                    "deprecated" : false,
                    "description" : "Addon price is calculated based on the addon type and charge type. [Learn more](https://www.chargebee.com/docs/addons.html#charge-type-and-pricing).\nThe unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                    "minimum" : 0,
                    "example" : null
                  },
                  "currency_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The currency code (ISO 4217 format) of the addon.\n",
                    "maxLength" : 3,
                    "example" : null
                  },
                  "period" : {
                    "type" : "integer",
                    "format" : "int32",
                    "deprecated" : false,
                    "description" : "Applicable only for recurring-addons. Along with 'period_unit' decides the term-price of this addon.\n",
                    "minimum" : 1,
                    "example" : null
                  },
                  "period_unit" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Applicable only for recurring-addons. Along with 'period' decides the term-price of this addon.\n\n* month - Charge based on month(s)\n* week - Charge based on week(s)\n* not_applicable - not applicable for this addon\n* year - Charge based on year(s)\n* day - Charge based on Day(S)\n",
                    "enum" : [ "day", "week", "month", "year", "not_applicable" ],
                    "example" : null
                  },
                  "pricing_model" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Defines how the charges for the addons are calculated.\n\n* tiered - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.\n* per_unit - A fixed price per unit quantity.\n* flat_fee - A fixed price that is not quantity-based.\n* volume - The per unit price is based on the tier that the total quantity falls in.\n* stairstep - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.\n",
                    "enum" : [ "flat_fee", "per_unit", "tiered", "volume", "stairstep" ],
                    "example" : null
                  },
                  "unit" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Specifies the type of quantity. For example, if the addon price is $10 and 'agent' is the unit of measure, the addon will be $10/agent.\nApplicable only for quantity type addons.\n",
                    "maxLength" : 30,
                    "example" : null
                  },
                  "enabled_in_portal" : {
                    "type" : "boolean",
                    "default" : true,
                    "deprecated" : false,
                    "description" : "If enabled, customers can select this addon using the 'Change Subscription' option in the customer portal.\n",
                    "example" : null
                  },
                  "taxable" : {
                    "type" : "boolean",
                    "default" : true,
                    "deprecated" : false,
                    "description" : "Specifies whether taxes apply to this addon. This value is set and returned even if [Taxes](https://www.chargebee.com/docs/tax.html)\nhave been disabled in Chargebee. However, the value is effective only while Taxes are enabled.\n",
                    "example" : null
                  },
                  "tax_profile_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Tax profile of the addon.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "avalara_sale_type" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Indicates the type of sale carried out. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)\nintegration.\n\n* retail - Transaction is a sale to an end user\n* vendor_use - Transaction is for an item that is subject to vendor use tax\n* wholesale - Transaction is a sale to another company that will resell your product or service to another consumer\n* consumed - Transaction is for an item that is consumed directly\n",
                    "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)\nintegration.\n",
                    "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)\nintegration.\n",
                    "example" : null
                  },
                  "tax_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The Avalara tax codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's [AvaTax for Sales integration](https://www.chargebee.com/docs/avalara.html)\n.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "hsn_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The [HSN code](https://cbic-gst.gov.in/gst-goods-services-rates.html)\nto which the item is mapped for calculating the customer's tax in India. Applicable only when both of the following conditions are true:\n\n* [**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.)\n* The [**AvaTax for Sales** integration](https://www.chargebee.com/docs/avalara.html) has been enabled in Chargebee.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "taxjar_product_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The TaxJar product codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's [TaxJar integration](https://www.chargebee.com/docs/taxjar.html)\n.\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)\ndisplayed on the invoice PDF.\n",
                    "maxLength" : 2000,
                    "example" : null
                  },
                  "meta_data" : {
                    "type" : "object",
                    "additionalProperties" : true,
                    "deprecated" : false,
                    "description" : "A collection of key-value pairs that provides extra information about the addon.  \n**Note:**\nThere's a character limit of 65,535.\n\n[Learn more](/docs/api/v2/pcv-1/advanced-features)\n.\n",
                    "example" : null
                  },
                  "sku" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The field is used as Product name/code in your third party accounting application. Chargebee will use it as an alternate name in your accounting application.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "accounting_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "This field is to capture the Account code setup in your Accounting system for integration purposes only.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "accounting_category1" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/1.0/finance-integration-index.html )\n\n* [**Xero:**](https://www.chargebee.com/docs/1.0/xero.html ) If you've categorized your products in Xero, provide the category name and option. Use the format: `:` . For example:`Location: Singapore.`\n* [**QuickBooks:**](https://www.chargebee.com/docs/1.0/quickbooks.html ) If you've categorized your product sales in QuickBooks according to Classes, provide the class name here. Use the following format: `::...`\n* [**NetSuite:**](https://www.chargebee.com/docs/1.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.`\n* [**Intacct:**](https://www.chargebee.com/docs/1.0/intacct.html ) If you've classified your products in Intacct under Locations, provide the name of the Location here.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "accounting_category2" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/1.0/finance-integration-index.html )\n\n* [**Xero:**](https://www.chargebee.com/docs/1.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`\n* [**QuickBooks:**](https://www.chargebee.com/docs/1.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`\n* [**NetSuite:**](https://www.chargebee.com/docs/1.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`\n* [**Intacct:**](https://www.chargebee.com/docs/1.0/intacct.html ) If you've classified your products in Intacct under Dimensions, provide the value of the Dimension here.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "accounting_category3" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/1.0/finance-integration-index.html )\n\n* [**NetSuite:**](https://www.chargebee.com/docs/1.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.`\n* [**Intacct:**](https://www.chargebee.com/docs/1.0/intacct.html ) If you've classified your products in Intacct under multiple Dimensions, provide the value of the second Dimension here. .\n",
                    "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 )\n\n* [**NetSuite:**](https://www.chargebee.com/docs/1.0/netsuite.html ) Provide the \"Revenue Recognition Rule Id\" for the product from NetSuite.\n* [**Intacct:**](https://www.chargebee.com/docs/1.0/intacct.html ) If you have configured \"Revenue Recognition Templates\" for products in Intacct, provide the template ID for the product. .\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "is_shippable" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "If enabled, charges for this plan/addon will be added to orders.\n",
                    "example" : null
                  },
                  "shipping_frequency_period" : {
                    "type" : "integer",
                    "format" : "int32",
                    "deprecated" : false,
                    "description" : "Defines the shipping frequency. Example: to bill customer every 2 weeks, provide \"2\" here.\n",
                    "minimum" : 1,
                    "example" : null
                  },
                  "shipping_frequency_period_unit" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Defines the shipping frequency in association with shipping period.\n\n* day - Ship based on day(s)\n* week - Ship based on week(s)\n* month - Ship based on month(s)\n* year - Ship based on year(s)\n",
                    "enum" : [ "year", "month", "week", "day" ],
                    "example" : null
                  },
                  "included_in_mrr" : {
                    "type" : "boolean",
                    "deprecated" : false,
                    "description" : "The addon is included in MRR calculations for your site. This attribute is only applicable for addons of `charge_type = non_recurring`\nand when the feature is enabled in Chargebee. Note: If the site-level setting is to exclude non-recurring addons from MRR calculations, this value is always returned `false`\n.\n",
                    "example" : null
                  },
                  "show_description_in_invoices" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "Whether the [addon description](/docs/api/v2/pcv-1/addons/addon-object)\nshould be shown on [invoice PDFs](/docs/api/invoices/retrieve-invoice-as-pdf).\nIf 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)\n) after the change are affected; past invoices are not.\n",
                    "example" : null
                  },
                  "show_description_in_quotes" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "Whether the [addon description](/docs/api/v2/pcv-1/addons/addon-object)\nshould be shown on [quote PDFs](/docs/api/quotes/retrieve-quote-as-pdf).\nIf this Boolean is changed, only quotes created after the change are affected; past quotes are not.\n",
                    "example" : null
                  },
                  "price_in_decimal" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The price of the addon when the `pricing_model`\nis `flat_fee`.\nWhen the pricing model is `per_unit`\n, 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/v2/pcv-1/currencies)\nis enabled.\n\nThis price is for the `period` of the addon. When attached to a plan, the addon is billed for the billing period of the plan. Learn more.\n",
                    "maxLength" : 39,
                    "example" : null
                  },
                  "proration_type" : {
                    "type" : "string",
                    "default" : "site_default",
                    "deprecated" : false,
                    "description" : "**Note**\nApplicable only for addons with [pricing_model](/docs/api/v2/pcv-1/addons/addon-object#pricing_model) = `per_unit`.\n\nSpecifies how to manage charges or credits for the addon during a [subscription update](/docs/api/v2/pcv-1/subscriptions/update-a-subscription)\nor [estimating](/docs/api/v2/pcv-1/estimates/update-subscription-estimate)\na subscription update.\n\n* full_term - Charge the full price of the addon item price or give the full credit. Don't apply any proration.\n* site_default -\n  Use the [site-wide proration setting](https://www.chargebee.com/docs/1.0/proration.html#proration-for-subscription-change)\n  .\n* partial_term - Prorate the charges or credits for the rest of the current term.\n",
                    "enum" : [ "site_default", "partial_term", "full_term" ],
                    "example" : null
                  },
                  "status" : {
                    "type" : "string",
                    "default" : "active",
                    "deprecated" : false,
                    "description" : "Status of the addon.\n\n* archived - No new associations with subscriptions are allowed. Existing associations for recurring addons remain as-is and can be removed if required.\n* active - Only active addons can be applied to subscriptions\n",
                    "enum" : [ "active", "archived" ],
                    "example" : null
                  },
                  "tiers" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for tiers\n",
                    "properties" : {
                      "starting_unit" : {
                        "type" : "array",
                        "description" : "The lower limit of a range of units for the tier\n",
                        "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\n",
                        "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`\nis `tiered`\nor `volume`\n; the total cost for the item price when the `pricing_model`\nis `stairstep`.\nThe value is in the [minor unit of the currency](/docs/api/v2/pcv-1/currencies)\n.\n",
                        "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`\nof the next lower tier. Applicable only when the `pricing_model`\nis `tiered`\n, `volume`\nor `stairstep`\nand [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis 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. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the `starting_unit_in_decimal`\nof the next higher tier. Applicable only when the `pricing_model`\nis `tiered`\n, `volume`\nor `stairstep`\nand [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis 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 `pricing_model`\nis `tiered`\nor `volume`.\nWhen the `pricing_model`\nis `stairstep`\n, it is the decimal representation of the total price for the plan. The value is in major units of the currency. Applicable when the plan is quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 39,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "example" : null
                  },
                  "tax_providers_fields" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for tax_providers_fields\n",
                    "properties" : {
                      "provider_name" : {
                        "type" : "array",
                        "description" : "Name of the tax provider currently supported.\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 us.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      },
                      "field_value" : {
                        "type" : "array",
                        "description" : "The value of the corresponding tax field.\n",
                        "items" : {
                          "type" : "string",
                          "deprecated" : false,
                          "maxLength" : 50,
                          "example" : null
                        },
                        "example" : null
                      }
                    },
                    "required" : [ "field_id", "field_value", "provider_name" ],
                    "example" : null
                  }
                },
                "required" : [ "charge_type", "id", "name" ],
                "example" : null
              },
              "encoding" : {
                "tax_providers_fields" : {
                  "style" : "deepObject",
                  "explode" : true
                },
                "tiers" : {
                  "style" : "deepObject",
                  "explode" : true
                }
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "addon" : {
                      "$ref" : "#/components/schemas/Addon",
                      "description" : "Resource object representing addon\n"
                    }
                  },
                  "required" : [ "addon" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/addons/{addon-id}/delete" : {
      "post" : {
        "tags" : [ "addons" ],
        "summary" : "Delete an addon",
        "description" : "When an addon that already has subscriptions/invoices linked to it is deleted, it does not get completely purged but is instead moved to \"Archived\" state. No other subscriptions can use this addon but subscriptions already on it will continue to renew. Once an addon has been archived, it cannot be edited or used again and the addon cannot be un-archived.\n\nIf no subscriptions or invoices are linked to an addon, the addon will be permanently deleted from your Chargebee site. This action cannot be undone.\n\nIf an addon that is an applicable item for a coupon is deleted, then the addon will be removed from that coupon's list of applicable items.\n\nArchiving an addon will not affect coupons in anyway.\n",
        "operationId" : "delete_an_addon",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "addon-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/addon-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "addon" : {
                      "$ref" : "#/components/schemas/Addon",
                      "description" : "Resource object representing addon\n"
                    }
                  },
                  "required" : [ "addon" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/coupons" : {
      "get" : {
        "tags" : [ "coupons" ],
        "summary" : "List coupons",
        "description" : "**Important**\n\nFor sites where both [legacy and latest](/docs/api/v2/pcv-1/upgrade#retrieving-api-responses-in-latest-api-format) product catalog versions are active, GET API requests return responses in a `compat` format by default. This format works with both latest and legacy Product Catalog.\n\n**Override options:**\n\n* `chargebee-response-schema-type: items` → Return response in latest product catalog format only.\n* `chargebee-response-schema-type: plans_addons` → Return response in legacy product catalog format only.\n\nList 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.\n",
        "operationId" : "list_coupons",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "limit",
          "in" : "query",
          "description" : "The number of resources to be returned.\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`\nto the value of `next_offset`\nobtained in the previous iteration of the API call.\n",
          "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\\] = \"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\n\nThe type of deduction. Possible values are : fixed_amount, percentage.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*discount_type\\[is\\] = \"fixed_amount\"*\n",
          "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.\n* `percentage` - The specified percentage will be deducted.\n* `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.\n* `percentage` - The specified percentage will be deducted.\n* `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.\n* `percentage` - The specified percentage will be deducted.\n* `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.\n* `percentage` - The specified percentage will be deducted.\n* `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\n\nSpecifies the time duration for which this coupon is attached to the subscription. Possible values are : one_time, forever, limited_period.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*duration_type\\[is\\] = \"forever\"*\n",
          "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.\n* `forever` - The coupon is attached to the subscription and applied on the invoices until explicitly removed.\n* `limited_period` - The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by `period` and `period_unit`.\n",
                "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.\n* `forever` - The coupon is attached to the subscription and applied on the invoices until explicitly removed.\n* `limited_period` - The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by `period` and `period_unit`.\n",
                "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.\n* `forever` - The coupon is attached to the subscription and applied on the invoices until explicitly removed.\n* `limited_period` - The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by `period` and `period_unit`.\n",
                "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.\n* `forever` - The coupon is attached to the subscription and applied on the invoices until explicitly removed.\n* `limited_period` - The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by `period` and `period_unit`.\n",
                "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\n\nStatus of the coupon. Possible values are : active, expired, archived, deleted.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*status\\[is\\] = \"active\"*\n",
          "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.\n* `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.\n* `archived` - Cannot be applied to a subscription. Existing associations remain unaffected.\n* `deleted` - Indicates the coupon has been deleted.\n",
                "enum" : [ "active", "expired", "archived", "deleted" ],
                "example" : null
              },
              "is_not" : {
                "type" : "string",
                "description" : "* `active` - Can be applied to a subscription.\n* `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.\n* `archived` - Cannot be applied to a subscription. Existing associations remain unaffected.\n* `deleted` - Indicates the coupon has been deleted.\n",
                "enum" : [ "active", "expired", "archived", "deleted" ],
                "example" : null
              },
              "in" : {
                "type" : "string",
                "description" : "* `active` - Can be applied to a subscription.\n* `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.\n* `archived` - Cannot be applied to a subscription. Existing associations remain unaffected.\n* `deleted` - Indicates the coupon has been deleted.\n",
                "enum" : [ "active", "expired", "archived", "deleted" ],
                "pattern" : "^\\[(active|expired|archived|deleted)(,(active|expired|archived|deleted))*\\]$",
                "example" : null
              },
              "not_in" : {
                "type" : "string",
                "description" : "* `active` - Can be applied to a subscription.\n* `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.\n* `archived` - Cannot be applied to a subscription. Existing associations remain unaffected.\n* `deleted` - Indicates the coupon has been deleted.\n",
                "enum" : [ "active", "expired", "archived", "deleted" ],
                "pattern" : "^\\[(active|expired|archived|deleted)(,(active|expired|archived|deleted))*\\]$",
                "example" : null
              }
            }
          }
        }, {
          "name" : "apply_on",
          "in" : "query",
          "description" : "optional, enumerated string filter\n\nThe amount on the invoice to which the coupon is applied. Possible values are : invoice_amount, each_specified_item.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*apply_on\\[is\\] = \"invoice_amount\"*\n",
          "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\n\nTimestamp indicating when this coupon is created.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*created_at\\[after\\] = \"145222875\"*\n",
          "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\n\nTo filter based on updated at. This attribute will be present only if the resource has been updated after 2016-11-09.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*updated_at\\[after\\] = \"1243545465\"*\n",
          "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\n\nSorts based on the specified attribute.\n**Supported attributes :**\ncreated_at\n\n**Supported sort-orders :**\nasc, desc\n\n**Example →**\n*sort_by\\[asc\\] = \"created_at\"*\n\nThis will sort the result based on the 'created_at' attribute in ascending(earliest first) order.\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
          }
        }, {
          "name" : "currency_code",
          "in" : "query",
          "description" : "optional, string filter\n\nThe currency code ([ISO 4217 format](https://www.chargebee.com/docs/supported-currencies.html)\n) of the coupon. Applicable for *fixed_amount*\ncoupons alone.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*currency_code\\[is\\] = \"USD\"*\n",
          "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" : "List of itemPrice ids for which these coupons are applicable.\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "example" : "day-pass-USD",
            "properties" : {
              "is" : {
                "type" : "string",
                "minLength" : 1,
                "example" : null
              },
              "in" : {
                "type" : "string",
                "pattern" : "^\\[(.*)(,.*)*\\]$",
                "example" : null
              }
            }
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "list" : {
                      "type" : "array",
                      "items" : {
                        "type" : "object",
                        "properties" : {
                          "coupon" : {
                            "$ref" : "#/components/schemas/Coupon",
                            "description" : "Resource object representing coupon"
                          }
                        },
                        "required" : [ "coupon" ],
                        "example" : null
                      },
                      "example" : null
                    },
                    "next_offset" : {
                      "type" : "string",
                      "description" : "This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.\n",
                      "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" : [ "coupons" ],
        "summary" : "Create a coupon",
        "description" : "This API creates a new coupon for a specific promotion or offers.\n",
        "operationId" : "create_a_coupon",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "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.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "discount_type" : {
                    "type" : "string",
                    "default" : "percentage",
                    "deprecated" : false,
                    "description" : "Specifies the type of discount to be applied.\n\n* fixed_amount -\n  A fixed amount is deducted as a discount. The discount amount is specified in [discount_amount](/docs/api/v2/pcv-1/coupons/create-a-coupon#discount_amount).  \n  [Learn more](https://www.chargebee.com/docs/1.0/coupons.html#fixed-amount)\n  about `fixed_amount`\n  coupons.\n* percentage -\n  A percentage of the original price is deducted as a discount. The discount percentage is specified in [discount_percentage](/docs/api/v2/pcv-1/coupons/create-a-coupon#discount_percentage).  \n  [Learn more](https://www.chargebee.com/docs/1.0/coupons.html#percentage)\n  about `percentage`\n  coupons.\n* offer_quantity -\n  A specified number of units of the plan or addon are offered for free. The number of free units is specified in [discount_quantity](/docs/api/v2/pcv-1/coupons/create-a-coupon#discount_quantity).\n  The `offer_quantity`\n  option is valid only when [apply_on](/docs/api/v2/pcv-1/coupons/create-a-coupon#apply_on)\n  is set to `each_specified_item`\n  and the `pricing_model`\n  of the [plan](/docs/api/v2/pcv-1/plans/plan-object#pricing_model)\n  or addon is `per_unit`.  \n  [Learn more](https://www.chargebee.com/docs/1.0/coupons.html#offer-quantity)\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)\n.\n",
                    "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)\n) of the coupon. Applicable for *fixed_amount*\ncoupons alone.\n",
                    "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.\n",
                    "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 [plan](/docs/api/v2/pcv-1/plans)\nor [addon](/docs/api/v2/pcv-1/addons)\n, without affecting the total quantity sold. This parameter is applicable only when the [discount_type](/docs/api/v2/pcv-1/coupons/create-a-coupon#discount_type)\nis set to `offer_quantity`\n.\n",
                    "minimum" : 1,
                    "example" : null
                  },
                  "apply_on" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The amount on the invoice to which the coupon is applied.\n\n* invoice_amount -\n  The coupon is applied to the invoice `sub_total`\n  .\n* each_specified_item -\n  The coupon is applied to the `invoice.line_item.amount`\n  that corresponds to the plan or addon specified by `plan_ids`\n  and `addon_ids`\n  .\n",
                    "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.\n\n* forever - The coupon is attached to the subscription and applied on the invoices until explicitly removed.\n* limited_period -\n  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`\n  and `period_unit`\n  .\n* one_time -\n  The coupon stays attached to the subscription till it is applied on an invoice **once**.\n  It is removed after that from the subscription.\n",
                    "enum" : [ "one_time", "forever", "limited_period" ],
                    "example" : null
                  },
                  "duration_month" : {
                    "type" : "integer",
                    "format" : "int32",
                    "deprecated" : false,
                    "description" : "**(Deprecated)**\nThe duration of time in months for which the coupon is attached to the subscription. Applicable only when `duration_type`\nis `limited_period`.\n\n**Note:**\nThis parameter has been deprecated. Use `period`\nand `period_unit`\ninstead.\n",
                    "maximum" : 240,
                    "minimum" : 1,
                    "example" : null
                  },
                  "valid_till" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "Date upto which the coupon can be applied to new subscriptions.\n",
                    "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)\ndisplayed on the invoice PDF.\n",
                    "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/v2/pcv-1/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`\nand 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`\n.\n",
                    "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`.\nApplicable only when [duration_type](/docs/api/coupons/coupon-object#duration_type)\nis [limited_period](/docs/api/coupons/coupon-object#duration_type)\n.\n",
                    "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)\nis [limited_period](/docs/api/coupons/coupon-object#duration_type)\n.\n\n* year - A period of 1 calendar year.\n* month - A period of 1 calendar month.\n* week - A period of 7 days.\n* day - A period of 24 hours.\n",
                    "enum" : [ "day", "week", "month", "year" ],
                    "example" : null
                  },
                  "plan_constraint" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Plans the coupon can be applied to.\n\n* all - Coupon applicable to all plans.\n* specific - Coupon only applicable to specified plans. If used, it is mandatory to specify the plan(s).\n* none - Coupon not applicable to any plans.\n",
                    "enum" : [ "none", "all", "specific" ],
                    "example" : null
                  },
                  "addon_constraint" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Addons the coupon can be applied to.\n\n* specific - Coupon only applicable to specified addons. If used, it is mandatory to specify the addon(s).\n* all - Coupon applicable to all addons.\n* none - Coupon not applicable to any addons.\n",
                    "enum" : [ "none", "all", "specific" ],
                    "example" : null
                  },
                  "plan_ids" : {
                    "type" : "array",
                    "deprecated" : false,
                    "description" : "Identifier of the plan.\n",
                    "items" : {
                      "type" : "string",
                      "deprecated" : false,
                      "maxLength" : 100,
                      "example" : null
                    },
                    "example" : null
                  },
                  "addon_ids" : {
                    "type" : "array",
                    "deprecated" : false,
                    "description" : "Identifier of the addon.\n",
                    "items" : {
                      "type" : "string",
                      "deprecated" : false,
                      "maxLength" : 100,
                      "example" : null
                    },
                    "example" : null
                  },
                  "status" : {
                    "type" : "string",
                    "default" : "active",
                    "deprecated" : false,
                    "description" : "Status of the coupon.\n\n* active - Can be applied to a subscription.\n* archived - Cannot be applied to a subscription. Existing associations remain unaffected.\n",
                    "enum" : [ "active", "archived" ],
                    "example" : null
                  }
                },
                "required" : [ "apply_on", "id", "name" ],
                "example" : null
              },
              "encoding" : { }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "coupon" : {
                      "$ref" : "#/components/schemas/Coupon",
                      "description" : "Resource object representing coupon\n"
                    }
                  },
                  "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.\n",
        "operationId" : "unarchive_a_coupon",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "coupon-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/coupon-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "coupon" : {
                      "$ref" : "#/components/schemas/Coupon",
                      "description" : "Resource object representing coupon\n"
                    }
                  },
                  "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.\n\nTo 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.\n",
        "operationId" : "delete_a_coupon",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "coupon-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/coupon-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "coupon" : {
                      "$ref" : "#/components/schemas/Coupon",
                      "description" : "Resource object representing coupon\n"
                    }
                  },
                  "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" : "Creates a coupon in this site by copying its configurations from another site. Copying of archived coupons is not supported.  \n**Note:**\n\n* The plans and addons (refer plan_constraint, plan_ids, addon_constraint, addon_ids) that are linked will also be copied. E.g. in the source site, the coupon C1 has P1 and P2 as applicable plans. Now, if in the destination site only the plan P1 is present, the newly created coupon will have only P1 as the applicable plan. So we recommend that you copy the necessary plans and addons before copying the coupons.\n* The 'redemptions' count is not copied. It will be 0 for the newly created coupon. Hence, if you are copying a Expired coupon (expired because max_redemptions is reached), its status will be 'Active' when created.\n",
        "operationId" : "copy_a_coupon",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "from_site" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Your Chargebee site name having the coupon to be copied.\n**Note:**\nUnless 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)\nto have this allow-listed.\n",
                    "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.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Id of copied coupon in this site.\n",
                    "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.\n**Note:**\nIf this parameter is passed true coupon state, redmeptions, coupon set and coupon codes associated with this coupon will be copied.\n",
                    "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\n"
                    }
                  },
                  "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" : "**Important**\n\nFor sites where both [legacy and latest](/docs/api/v2/pcv-1/upgrade#retrieving-api-responses-in-latest-api-format) product catalog versions are active, GET API requests return responses in a `compat` format by default. This format works with both latest and legacy Product Catalog.\n\n**Override options:**\n\n* `chargebee-response-schema-type: items` → Return response in latest product catalog format only.\n* `chargebee-response-schema-type: plans_addons` → Return response in legacy product catalog format only.\n\nThis API retrieves a specific coupon using the coupon ID.\n",
        "operationId" : "retrieve_a_coupon",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "coupon-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/coupon-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "coupon" : {
                      "$ref" : "#/components/schemas/Coupon",
                      "description" : "Resource object representing coupon\n"
                    }
                  },
                  "required" : [ "coupon" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      },
      "post" : {
        "tags" : [ "coupons" ],
        "summary" : "Update a coupon",
        "description" : "When updating coupons that are already linked to an invoice or subscription you can only update the following parameters:\n\n* name\n* invoice name\n* plan_constraint - Applicable when apply_on is set as each_specified_item. Allows change from none to all, none to specific, and specific to all.\n* addon_constraint - Applicable when apply_on is set as each_specified_item. Allows change from none to all, none to specific, and specific to all.\n* plan_ids - Applicable when plan_constraint is set as specific. Allows addition of new plan_ids. However, existing plan_ids cannot be removed.\n* addon_ids - Applicable when addon_constraint is set as specific. Allows addition of new addon_ids. However, existing addon_ids cannot be removed.\n* valid_till\n* max_redemptions\n* invoice_notes\n* included_in_mrr\n* meta_data\n",
        "operationId" : "update_a_coupon",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "coupon-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/coupon-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "name" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "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.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "discount_type" : {
                    "type" : "string",
                    "default" : "percentage",
                    "deprecated" : false,
                    "description" : "Specifies the type of discount to be applied.\n\n* fixed_amount -\n  A fixed amount is deducted as a discount. The discount amount is specified in [discount_amount](/docs/api/v2/pcv-1/coupons/update-a-coupon#discount_amount).  \n  [Learn more](https://www.chargebee.com/docs/1.0/coupons.html#fixed-amount)\n  about `fixed_amount`\n  coupons.\n* percentage -\n  A percentage of the original price is deducted as a discount. The discount percentage is specified in [discount_percentage](/docs/api/v2/pcv-1/coupons/update-a-coupon#discount_percentage).  \n  [Learn more](https://www.chargebee.com/docs/1.0/coupons.html#percentage)\n  about `percentage`\n  coupons.\n* offer_quantity -\n  A specified number of units of the plan or addon are offered for free. The number of free units is specified in [discount_quantity](/docs/api/v2/pcv-1/coupons/update-a-coupon#discount_quantity).\n  The `offer_quantity`\n  option is valid only when [apply_on](/docs/api/v2/pcv-1/coupons/update-a-coupon#apply_on)\n  is set to `each_specified_item`\n  and the `pricing_model`\n  of the [plan](/docs/api/v2/pcv-1/plans/plan-object#pricing_model)\n  or addon is `per_unit`.  \n  [Learn more](https://www.chargebee.com/docs/1.0/coupons.html#offer-quantity)\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)\n.\n",
                    "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)\n) of the coupon. Applicable for *fixed_amount*\ncoupons alone.\n",
                    "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.\n",
                    "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 [plan](/docs/api/v2/pcv-1/plans)\nor [addon](/docs/api/v2/pcv-1/addons)\n, without affecting the total quantity sold. This parameter is applicable only when the [discount_type](/docs/api/v2/pcv-1/coupons/update-a-coupon#discount_type)\nis set to `offer_quantity`\n.\n",
                    "minimum" : 1,
                    "example" : null
                  },
                  "apply_on" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The amount on the invoice to which the coupon is applied.\n\n* invoice_amount -\n  The coupon is applied to the invoice `sub_total`\n  .\n* each_specified_item -\n  The coupon is applied to the `invoice.line_item.amount`\n  that corresponds to the plan or addon specified by `plan_ids`\n  and `addon_ids`\n  .\n",
                    "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.\n\n* forever - The coupon is attached to the subscription and applied on the invoices until explicitly removed.\n* limited_period -\n  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`\n  and `period_unit`\n  .\n* one_time -\n  The coupon stays attached to the subscription till it is applied on an invoice **once**.\n  It is removed after that from the subscription.\n",
                    "enum" : [ "one_time", "forever", "limited_period" ],
                    "example" : null
                  },
                  "duration_month" : {
                    "type" : "integer",
                    "format" : "int32",
                    "deprecated" : false,
                    "description" : "**(Deprecated)**\nThe duration of time in months for which the coupon is attached to the subscription. Applicable only when `duration_type`\nis `limited_period`.\n\n**Note:**\nThis parameter has been deprecated. Use `period`\nand `period_unit`\ninstead.\n",
                    "maximum" : 240,
                    "minimum" : 1,
                    "example" : null
                  },
                  "valid_till" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "Date upto which the coupon can be applied to new subscriptions.\n",
                    "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)\ndisplayed on the invoice PDF.\n",
                    "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/v2/pcv-1/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`\nand 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`\n.\n",
                    "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`.\nApplicable only when [duration_type](/docs/api/coupons/coupon-object#duration_type)\nis [limited_period](/docs/api/coupons/coupon-object#duration_type)\n.\n",
                    "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)\nis [limited_period](/docs/api/coupons/coupon-object#duration_type)\n.\n\n* year - A period of 1 calendar year.\n* month - A period of 1 calendar month.\n* week - A period of 7 days.\n* day - A period of 24 hours.\n",
                    "enum" : [ "day", "week", "month", "year" ],
                    "example" : null
                  },
                  "plan_constraint" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Plans the coupon can be applied to.\n\n* all - Coupon applicable to all plans.\n* specific - Coupon only applicable to specified plans. If used, it is mandatory to specify the plan(s).\n* none - Coupon not applicable to any plans.\n",
                    "enum" : [ "none", "all", "specific" ],
                    "example" : null
                  },
                  "addon_constraint" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Addons the coupon can be applied to.\n\n* specific - Coupon only applicable to specified addons. If used, it is mandatory to specify the addon(s).\n* all - Coupon applicable to all addons.\n* none - Coupon not applicable to any addons.\n",
                    "enum" : [ "none", "all", "specific" ],
                    "example" : null
                  },
                  "plan_ids" : {
                    "type" : "array",
                    "deprecated" : false,
                    "description" : "Identifier of the plan.\n",
                    "items" : {
                      "type" : "string",
                      "deprecated" : false,
                      "maxLength" : 100,
                      "example" : null
                    },
                    "example" : null
                  },
                  "addon_ids" : {
                    "type" : "array",
                    "deprecated" : false,
                    "description" : "Identifier of the addon.\n",
                    "items" : {
                      "type" : "string",
                      "deprecated" : false,
                      "maxLength" : 100,
                      "example" : null
                    },
                    "example" : null
                  }
                },
                "example" : null
              },
              "encoding" : { }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "coupon" : {
                      "$ref" : "#/components/schemas/Coupon",
                      "description" : "Resource object representing coupon\n"
                    }
                  },
                  "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.\n",
        "operationId" : "list_coupon_sets",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "limit",
          "in" : "query",
          "description" : "The number of resources to be returned.\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`\nto the value of `next_offset`\nobtained in the previous iteration of the API call.\n",
          "required" : false,
          "deprecated" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "maxLength" : 1000,
            "example" : null
          }
        }, {
          "name" : "id",
          "in" : "query",
          "description" : "optional, string filter\n\nUniquely identifies a coupon_set.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*id\\[is\\] = \"bulk-codes-1\"*\n",
          "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\n\nName of the coupon set.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*name\\[is\\] = \"bulk-codes-1\"*\n",
          "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\n\nCoupon id linked to coupon set.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*coupon_id\\[is_not\\] = \"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" : "total_count",
          "in" : "query",
          "description" : "optional, integer filter\n\nNo of coupon codes present in coupon set.\n**Supported operators :**\nis, is_not, lt, lte, gt, gte, between\n\n**Example →**\n*total_count\\[is_not\\] = \"10\"*\n",
          "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\n\nNo of redeemed codes.\n**Supported operators :**\nis, is_not, lt, lte, gt, gte, between\n\n**Example →**\n*redeemed_count\\[gt\\] = \"5\"*\n",
          "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\n\nNo of archived codes.\n**Supported operators :**\nis, is_not, lt, lte, gt, gte, between\n\n**Example →**\n*archived_count\\[lte\\] = \"2\"*\n",
          "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`.\n",
                      "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\n",
        "operationId" : "create_a_coupon_set",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "coupon_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Coupon id linked to coupon set.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "name" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Name of the coupon set.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Uniquely identifies a coupon_set.\n",
                    "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/v2/pcv-1/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\n"
                    }
                  },
                  "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`.\n",
        "operationId" : "update_a_coupon_set",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "coupon-set-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/coupon-set-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "name" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Name of the coupon set.\n",
                    "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/v2/pcv-1/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\n"
                    }
                  },
                  "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.\n",
        "operationId" : "retrieve_a_coupon_set",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "coupon-set-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/coupon-set-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "coupon_set" : {
                      "$ref" : "#/components/schemas/CouponSet",
                      "description" : "Resource object representing coupon_set\n"
                    }
                  },
                  "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.\n",
        "operationId" : "add_coupon_codes_to_coupon_set",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "coupon-set-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/coupon-set-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "code" : {
                    "type" : "array",
                    "deprecated" : false,
                    "description" : "You can pass up to 100 values per API call. You can also use the Chargebee UI to pass up to 1000 codes per operation. There is no limit on the total number of coupon codes that can be included in a coupon set.\n",
                    "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\n"
                    }
                  },
                  "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.\n",
        "operationId" : "delete_unused_coupon_codes",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "coupon-set-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/coupon-set-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "coupon_set" : {
                      "$ref" : "#/components/schemas/CouponSet",
                      "description" : "Resource object representing coupon_set\n"
                    }
                  },
                  "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\n",
        "operationId" : "delete_a_coupon_set",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "coupon-set-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/coupon-set-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "coupon_set" : {
                      "$ref" : "#/components/schemas/CouponSet",
                      "description" : "Resource object representing coupon_set\n"
                    }
                  },
                  "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.\n",
        "operationId" : "list_coupon_codes",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "limit",
          "in" : "query",
          "description" : "The number of resources to be returned.\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`\nto the value of `next_offset`\nobtained in the previous iteration of the API call.\n",
          "required" : false,
          "deprecated" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "maxLength" : 1000,
            "example" : null
          }
        }, {
          "name" : "code",
          "in" : "query",
          "description" : "optional, string filter\n\nUnique coupon code that can be redeemed only once.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*code\\[is\\] = \"OFF2009\"*\n",
          "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\n\nId of the main coupon resource.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*coupon_id\\[is\\] = \"OFF20\"*\n",
          "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\n\nCoupon 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.\n**Supported operators :**\nis, is_not, starts_with\n\n**Example →**\n*coupon_set_name\\[is_not\\] = \"OFF20\"*\n",
          "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\n\nStatus of the coupon code. Possible values are : not_redeemed, redeemed, archived.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*status\\[is\\] = \"redeemed\"*\n",
          "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.\n* `redeemed` - Cannot be applied to a subscription as the coupon code has been already used.\n* `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.\n* `redeemed` - Cannot be applied to a subscription as the coupon code has been already used.\n* `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.\n* `redeemed` - Cannot be applied to a subscription as the coupon code has been already used.\n* `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.\n* `redeemed` - Cannot be applied to a subscription as the coupon code has been already used.\n* `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`.\n",
                      "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.\n",
        "operationId" : "retrieve_a_coupon_code",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "coupon-code-code",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/coupon-code-code",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "coupon_code" : {
                      "$ref" : "#/components/schemas/CouponCode",
                      "description" : "Resource object representing coupon_code\n"
                    }
                  },
                  "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.\n",
        "operationId" : "archive_a_coupon_code",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "coupon-code-code",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/coupon-code-code",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "coupon_code" : {
                      "$ref" : "#/components/schemas/CouponCode",
                      "description" : "Resource object representing coupon_code\n"
                    }
                  },
                  "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.\n",
        "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.\n",
          "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.\n",
          "required" : true,
          "deprecated" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 50,
            "example" : null
          }
        }, {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "address" : {
                      "$ref" : "#/components/schemas/Address",
                      "description" : "Resource object representing address\n"
                    }
                  },
                  "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.\n",
        "operationId" : "update_an_address",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "subscription_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "A unique and immutable identifier for the subscription. If not provided, it is autogenerated.\n",
                    "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.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "first_name" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "First name.\n",
                    "maxLength" : 150,
                    "example" : null
                  },
                  "last_name" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Last name.\n",
                    "maxLength" : 150,
                    "example" : null
                  },
                  "email" : {
                    "type" : "string",
                    "format" : "email",
                    "deprecated" : false,
                    "description" : "Email.\n",
                    "maxLength" : 70,
                    "example" : null
                  },
                  "company" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Company name.\n",
                    "maxLength" : 250,
                    "example" : null
                  },
                  "phone" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Phone number.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "addr" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Address line 1.\n",
                    "maxLength" : 150,
                    "example" : null
                  },
                  "extended_addr" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Address line 2.\n",
                    "maxLength" : 150,
                    "example" : null
                  },
                  "extended_addr2" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Address line 3.\n",
                    "maxLength" : 150,
                    "example" : null
                  },
                  "city" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                    "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`\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.\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://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.\n\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* not_validated - Address is not yet validated.\n* invalid - Address is invalid.\n* valid - Address was validated successfully.\n",
                    "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\n"
                    }
                  },
                  "required" : [ "address" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/events" : {
      "get" : {
        "tags" : [ "events" ],
        "summary" : "List events",
        "description" : "Retrieves list of events.\n",
        "operationId" : "list_events",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "limit",
          "in" : "query",
          "description" : "The number of resources to be returned.\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`\nto the value of `next_offset`\nobtained in the previous iteration of the API call.\n",
          "required" : false,
          "deprecated" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "maxLength" : 1000,
            "example" : null
          }
        }, {
          "name" : "id",
          "in" : "query",
          "description" : "optional, string filter\n\nUniquely identifies a event.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*id\\[is_not\\] = \"8ndk0hbKm\"*\n",
          "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\n\nReturns the events (occurred in the past 6 days) which has this status in any of the events' webhooks.\n**Note**:\nTo 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.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*webhook_status\\[is\\] = \"succeeded\"*\n",
          "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\n* `scheduled` - Webhook call has been scheduled.\n* `succeeded` - Webhook call was successful.\n* `re_scheduled` - Webhook call has been rescheduled due failure(s) in previous call(s)\n* `failed` - Webhook call has been suspended after the all retries have resulted in failure.\n* `skipped` - Skipped as specified in request\n* `not_applicable` - Webhook call is not applicable for this event.\n* `disabled` - Disabled as no longer used\n* `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\n* `scheduled` - Webhook call has been scheduled.\n* `succeeded` - Webhook call was successful.\n* `re_scheduled` - Webhook call has been rescheduled due failure(s) in previous call(s)\n* `failed` - Webhook call has been suspended after the all retries have resulted in failure.\n* `skipped` - Skipped as specified in request\n* `not_applicable` - Webhook call is not applicable for this event.\n* `disabled` - Disabled as no longer used\n* `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\n* `scheduled` - Webhook call has been scheduled.\n* `succeeded` - Webhook call was successful.\n* `re_scheduled` - Webhook call has been rescheduled due failure(s) in previous call(s)\n* `failed` - Webhook call has been suspended after the all retries have resulted in failure.\n* `skipped` - Skipped as specified in request\n* `not_applicable` - Webhook call is not applicable for this event.\n* `disabled` - Disabled as no longer used\n* `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\n* `scheduled` - Webhook call has been scheduled.\n* `succeeded` - Webhook call was successful.\n* `re_scheduled` - Webhook call has been rescheduled due failure(s) in previous call(s)\n* `failed` - Webhook call has been suspended after the all retries have resulted in failure.\n* `skipped` - Skipped as specified in request\n* `not_applicable` - Webhook call is not applicable for this event.\n* `disabled` - Disabled as no longer used\n* `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\n\nSpecify it if you need to fetch events of a particular type. Possible values are : plan_created, plan_updated, plan_deleted, addon_created, addon_updated, addon_deleted, coupon_created, coupon_updated, coupon_deleted, coupon_set_created, coupon_set_updated, coupon_set_deleted, coupon_codes_added, coupon_codes_deleted, coupon_codes_updated, customer_created, customer_changed, customer_deleted, customer_moved_out, customer_moved_in, promotional_credits_added, promotional_credits_deducted, subscription_created, subscription_created_with_backdating, subscription_started, subscription_trial_end_reminder, subscription_activated, subscription_activated_with_backdating, subscription_changed, mrr_updated, subscription_changed_with_backdating, subscription_cancellation_scheduled, subscription_cancellation_reminder, subscription_cancelled, subscription_canceled_with_backdating, subscription_reactivated, subscription_reactivated_with_backdating, subscription_renewed, subscription_scheduled_cancellation_removed, subscription_changes_scheduled, subscription_scheduled_changes_removed, subscription_shipping_address_updated, subscription_deleted, subscription_paused, subscription_pause_scheduled, subscription_scheduled_pause_removed, subscription_resumed, subscription_resumption_scheduled, subscription_scheduled_resumption_removed, subscription_advance_invoice_schedule_added, subscription_advance_invoice_schedule_updated, subscription_advance_invoice_schedule_removed, pending_invoice_created, pending_invoice_updated, invoice_generated, invoice_generated_with_backdating, invoice_updated, invoice_deleted, credit_note_created, credit_note_created_with_backdating, credit_note_updated, credit_note_deleted, subscription_renewal_reminder, transaction_created, transaction_updated, transaction_deleted, payment_succeeded, payment_failed, payment_refunded, payment_initiated, refund_initiated, authorization_succeeded, authorization_voided, card_added, card_updated, card_expiry_reminder, card_expired, card_deleted, payment_source_added, payment_source_updated, payment_source_deleted, payment_source_expiring, payment_source_expired, virtual_bank_account_added, virtual_bank_account_updated, virtual_bank_account_deleted, token_created, token_consumed, token_expired, unbilled_charges_created, unbilled_charges_voided, unbilled_charges_deleted, unbilled_charges_invoiced, order_created, order_updated, order_cancelled, order_delivered, order_returned, order_ready_to_process, order_ready_to_ship, order_deleted, order_resent, quote_created, quote_updated, quote_deleted, tax_withheld_recorded, tax_withheld_deleted, tax_withheld_refunded, gift_scheduled, gift_unclaimed, gift_claimed, gift_expired, gift_cancelled, gift_updated, hierarchy_created, hierarchy_deleted, payment_intent_created, payment_intent_updated, contract_term_created, contract_term_renewed, contract_term_terminated, contract_term_completed, contract_term_cancelled.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*event_type\\[is\\] = \"customer_created\"*\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "example" : "customer_created",
            "properties" : {
              "is" : {
                "type" : "string",
                "description" : "* `plan_created` - Sent when a plan is created. \n* `plan_updated` - Sent when a plan is changed. \n* `plan_deleted` - Sent when a plan is deleted. \n* `addon_created` - Sent when a addon is created. \n* `addon_updated` - Sent when a addon is changed. \n* `addon_deleted` - Sent when a addon is deleted. \n* `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* `subscription_renewal_reminder` - Sent before each subscription's renewal based on plan's period\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* `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* `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* `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* `omnichannel_subscription_item_pause_scheduled` - Triggered when an omnichannel subscription item scheduled for pause\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.",
                "enum" : [ "plan_created", "plan_updated", "plan_deleted", "addon_created", "addon_updated", "addon_deleted", "coupon_created", "coupon_updated", "coupon_deleted", "coupon_set_created", "coupon_set_updated", "coupon_set_deleted", "coupon_codes_added", "coupon_codes_deleted", "coupon_codes_updated", "customer_created", "customer_changed", "customer_deleted", "customer_moved_out", "customer_moved_in", "promotional_credits_added", "promotional_credits_deducted", "subscription_created", "subscription_created_with_backdating", "subscription_started", "subscription_trial_end_reminder", "subscription_activated", "subscription_activated_with_backdating", "subscription_changed", "subscription_trial_extended", "mrr_updated", "subscription_changed_with_backdating", "subscription_cancellation_scheduled", "subscription_cancellation_reminder", "subscription_cancelled", "subscription_canceled_with_backdating", "subscription_reactivated", "subscription_reactivated_with_backdating", "subscription_renewed", "subscription_items_renewed", "subscription_scheduled_cancellation_removed", "subscription_changes_scheduled", "subscription_scheduled_changes_removed", "subscription_shipping_address_updated", "subscription_deleted", "subscription_paused", "subscription_pause_scheduled", "subscription_scheduled_pause_removed", "subscription_resumed", "subscription_resumption_scheduled", "subscription_scheduled_resumption_removed", "subscription_advance_invoice_schedule_added", "subscription_advance_invoice_schedule_updated", "subscription_advance_invoice_schedule_removed", "pending_invoice_created", "pending_invoice_updated", "invoice_generated", "invoice_generated_with_backdating", "invoice_updated", "invoice_deleted", "credit_note_created", "credit_note_created_with_backdating", "credit_note_updated", "credit_note_deleted", "einvoice_created", "einvoice_updated", "subscription_renewal_reminder", "transaction_created", "transaction_updated", "transaction_deleted", "payment_succeeded", "payment_failed", "dunning_updated", "payment_refunded", "payment_initiated", "refund_initiated", "authorization_succeeded", "authorization_voided", "card_added", "card_updated", "card_expiry_reminder", "card_expired", "card_deleted", "payment_source_added", "payment_source_updated", "payment_source_deleted", "payment_source_expiring", "payment_source_expired", "payment_source_locally_deleted", "virtual_bank_account_added", "virtual_bank_account_updated", "virtual_bank_account_deleted", "token_created", "token_consumed", "token_expired", "unbilled_charges_created", "unbilled_charges_voided", "unbilled_charges_deleted", "unbilled_charges_invoiced", "order_created", "order_updated", "order_cancelled", "order_delivered", "order_returned", "order_ready_to_process", "order_ready_to_ship", "order_deleted", "order_resent", "quote_created", "quote_updated", "quote_deleted", "tax_withheld_recorded", "tax_withheld_deleted", "tax_withheld_refunded", "gift_scheduled", "gift_unclaimed", "gift_claimed", "gift_expired", "gift_cancelled", "gift_updated", "hierarchy_created", "hierarchy_deleted", "payment_intent_created", "payment_intent_updated", "contract_term_created", "contract_term_renewed", "contract_term_terminated", "contract_term_completed", "contract_term_cancelled", "voucher_created", "voucher_expired", "voucher_create_failed", "subscription_ramp_created", "subscription_ramp_deleted", "subscription_ramp_applied", "subscription_ramp_drafted", "subscription_ramp_updated", "subscription_moved_in", "subscription_moved_out", "subscription_movement_failed", "omnichannel_subscription_created", "omnichannel_subscription_item_renewed", "omnichannel_subscription_item_downgraded", "omnichannel_subscription_item_expired", "omnichannel_subscription_item_cancellation_scheduled", "omnichannel_subscription_item_scheduled_cancellation_removed", "omnichannel_subscription_item_resubscribed", "omnichannel_subscription_item_upgraded", "omnichannel_subscription_item_cancelled", "omnichannel_subscription_imported", "omnichannel_subscription_item_grace_period_started", "omnichannel_subscription_item_grace_period_expired", "omnichannel_subscription_item_dunning_started", "omnichannel_subscription_item_dunning_expired", "rule_created", "rule_updated", "rule_deleted", "record_purchase_failed", "omnichannel_subscription_item_change_scheduled", "omnichannel_subscription_item_scheduled_change_removed", "omnichannel_subscription_item_reactivated", "sales_order_created", "sales_order_updated", "omnichannel_subscription_item_changed", "omnichannel_subscription_item_paused", "omnichannel_subscription_item_resumed", "omnichannel_one_time_order_created", "omnichannel_one_time_order_item_cancelled", "omnichannel_subscription_item_pause_scheduled", "vault_token_created", "vault_token_updated", "vault_token_deleted" ],
                "example" : null
              },
              "is_not" : {
                "type" : "string",
                "description" : "* `plan_created` - Sent when a plan is created. \n* `plan_updated` - Sent when a plan is changed. \n* `plan_deleted` - Sent when a plan is deleted. \n* `addon_created` - Sent when a addon is created. \n* `addon_updated` - Sent when a addon is changed. \n* `addon_deleted` - Sent when a addon is deleted. \n* `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* `subscription_renewal_reminder` - Sent before each subscription's renewal based on plan's period\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* `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* `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* `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* `omnichannel_subscription_item_pause_scheduled` - Triggered when an omnichannel subscription item scheduled for pause\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.",
                "enum" : [ "plan_created", "plan_updated", "plan_deleted", "addon_created", "addon_updated", "addon_deleted", "coupon_created", "coupon_updated", "coupon_deleted", "coupon_set_created", "coupon_set_updated", "coupon_set_deleted", "coupon_codes_added", "coupon_codes_deleted", "coupon_codes_updated", "customer_created", "customer_changed", "customer_deleted", "customer_moved_out", "customer_moved_in", "promotional_credits_added", "promotional_credits_deducted", "subscription_created", "subscription_created_with_backdating", "subscription_started", "subscription_trial_end_reminder", "subscription_activated", "subscription_activated_with_backdating", "subscription_changed", "subscription_trial_extended", "mrr_updated", "subscription_changed_with_backdating", "subscription_cancellation_scheduled", "subscription_cancellation_reminder", "subscription_cancelled", "subscription_canceled_with_backdating", "subscription_reactivated", "subscription_reactivated_with_backdating", "subscription_renewed", "subscription_items_renewed", "subscription_scheduled_cancellation_removed", "subscription_changes_scheduled", "subscription_scheduled_changes_removed", "subscription_shipping_address_updated", "subscription_deleted", "subscription_paused", "subscription_pause_scheduled", "subscription_scheduled_pause_removed", "subscription_resumed", "subscription_resumption_scheduled", "subscription_scheduled_resumption_removed", "subscription_advance_invoice_schedule_added", "subscription_advance_invoice_schedule_updated", "subscription_advance_invoice_schedule_removed", "pending_invoice_created", "pending_invoice_updated", "invoice_generated", "invoice_generated_with_backdating", "invoice_updated", "invoice_deleted", "credit_note_created", "credit_note_created_with_backdating", "credit_note_updated", "credit_note_deleted", "einvoice_created", "einvoice_updated", "subscription_renewal_reminder", "transaction_created", "transaction_updated", "transaction_deleted", "payment_succeeded", "payment_failed", "dunning_updated", "payment_refunded", "payment_initiated", "refund_initiated", "authorization_succeeded", "authorization_voided", "card_added", "card_updated", "card_expiry_reminder", "card_expired", "card_deleted", "payment_source_added", "payment_source_updated", "payment_source_deleted", "payment_source_expiring", "payment_source_expired", "payment_source_locally_deleted", "virtual_bank_account_added", "virtual_bank_account_updated", "virtual_bank_account_deleted", "token_created", "token_consumed", "token_expired", "unbilled_charges_created", "unbilled_charges_voided", "unbilled_charges_deleted", "unbilled_charges_invoiced", "order_created", "order_updated", "order_cancelled", "order_delivered", "order_returned", "order_ready_to_process", "order_ready_to_ship", "order_deleted", "order_resent", "quote_created", "quote_updated", "quote_deleted", "tax_withheld_recorded", "tax_withheld_deleted", "tax_withheld_refunded", "gift_scheduled", "gift_unclaimed", "gift_claimed", "gift_expired", "gift_cancelled", "gift_updated", "hierarchy_created", "hierarchy_deleted", "payment_intent_created", "payment_intent_updated", "contract_term_created", "contract_term_renewed", "contract_term_terminated", "contract_term_completed", "contract_term_cancelled", "voucher_created", "voucher_expired", "voucher_create_failed", "subscription_ramp_created", "subscription_ramp_deleted", "subscription_ramp_applied", "subscription_ramp_drafted", "subscription_ramp_updated", "subscription_moved_in", "subscription_moved_out", "subscription_movement_failed", "omnichannel_subscription_created", "omnichannel_subscription_item_renewed", "omnichannel_subscription_item_downgraded", "omnichannel_subscription_item_expired", "omnichannel_subscription_item_cancellation_scheduled", "omnichannel_subscription_item_scheduled_cancellation_removed", "omnichannel_subscription_item_resubscribed", "omnichannel_subscription_item_upgraded", "omnichannel_subscription_item_cancelled", "omnichannel_subscription_imported", "omnichannel_subscription_item_grace_period_started", "omnichannel_subscription_item_grace_period_expired", "omnichannel_subscription_item_dunning_started", "omnichannel_subscription_item_dunning_expired", "rule_created", "rule_updated", "rule_deleted", "record_purchase_failed", "omnichannel_subscription_item_change_scheduled", "omnichannel_subscription_item_scheduled_change_removed", "omnichannel_subscription_item_reactivated", "sales_order_created", "sales_order_updated", "omnichannel_subscription_item_changed", "omnichannel_subscription_item_paused", "omnichannel_subscription_item_resumed", "omnichannel_one_time_order_created", "omnichannel_one_time_order_item_cancelled", "omnichannel_subscription_item_pause_scheduled", "vault_token_created", "vault_token_updated", "vault_token_deleted" ],
                "example" : null
              },
              "in" : {
                "type" : "string",
                "description" : "* `plan_created` - Sent when a plan is created. \n* `plan_updated` - Sent when a plan is changed. \n* `plan_deleted` - Sent when a plan is deleted. \n* `addon_created` - Sent when a addon is created. \n* `addon_updated` - Sent when a addon is changed. \n* `addon_deleted` - Sent when a addon is deleted. \n* `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* `subscription_renewal_reminder` - Sent before each subscription's renewal based on plan's period\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* `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* `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* `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* `omnichannel_subscription_item_pause_scheduled` - Triggered when an omnichannel subscription item scheduled for pause\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.",
                "enum" : [ "plan_created", "plan_updated", "plan_deleted", "addon_created", "addon_updated", "addon_deleted", "coupon_created", "coupon_updated", "coupon_deleted", "coupon_set_created", "coupon_set_updated", "coupon_set_deleted", "coupon_codes_added", "coupon_codes_deleted", "coupon_codes_updated", "customer_created", "customer_changed", "customer_deleted", "customer_moved_out", "customer_moved_in", "promotional_credits_added", "promotional_credits_deducted", "subscription_created", "subscription_created_with_backdating", "subscription_started", "subscription_trial_end_reminder", "subscription_activated", "subscription_activated_with_backdating", "subscription_changed", "subscription_trial_extended", "mrr_updated", "subscription_changed_with_backdating", "subscription_cancellation_scheduled", "subscription_cancellation_reminder", "subscription_cancelled", "subscription_canceled_with_backdating", "subscription_reactivated", "subscription_reactivated_with_backdating", "subscription_renewed", "subscription_items_renewed", "subscription_scheduled_cancellation_removed", "subscription_changes_scheduled", "subscription_scheduled_changes_removed", "subscription_shipping_address_updated", "subscription_deleted", "subscription_paused", "subscription_pause_scheduled", "subscription_scheduled_pause_removed", "subscription_resumed", "subscription_resumption_scheduled", "subscription_scheduled_resumption_removed", "subscription_advance_invoice_schedule_added", "subscription_advance_invoice_schedule_updated", "subscription_advance_invoice_schedule_removed", "pending_invoice_created", "pending_invoice_updated", "invoice_generated", "invoice_generated_with_backdating", "invoice_updated", "invoice_deleted", "credit_note_created", "credit_note_created_with_backdating", "credit_note_updated", "credit_note_deleted", "einvoice_created", "einvoice_updated", "subscription_renewal_reminder", "transaction_created", "transaction_updated", "transaction_deleted", "payment_succeeded", "payment_failed", "dunning_updated", "payment_refunded", "payment_initiated", "refund_initiated", "authorization_succeeded", "authorization_voided", "card_added", "card_updated", "card_expiry_reminder", "card_expired", "card_deleted", "payment_source_added", "payment_source_updated", "payment_source_deleted", "payment_source_expiring", "payment_source_expired", "payment_source_locally_deleted", "virtual_bank_account_added", "virtual_bank_account_updated", "virtual_bank_account_deleted", "token_created", "token_consumed", "token_expired", "unbilled_charges_created", "unbilled_charges_voided", "unbilled_charges_deleted", "unbilled_charges_invoiced", "order_created", "order_updated", "order_cancelled", "order_delivered", "order_returned", "order_ready_to_process", "order_ready_to_ship", "order_deleted", "order_resent", "quote_created", "quote_updated", "quote_deleted", "tax_withheld_recorded", "tax_withheld_deleted", "tax_withheld_refunded", "gift_scheduled", "gift_unclaimed", "gift_claimed", "gift_expired", "gift_cancelled", "gift_updated", "hierarchy_created", "hierarchy_deleted", "payment_intent_created", "payment_intent_updated", "contract_term_created", "contract_term_renewed", "contract_term_terminated", "contract_term_completed", "contract_term_cancelled", "voucher_created", "voucher_expired", "voucher_create_failed", "subscription_ramp_created", "subscription_ramp_deleted", "subscription_ramp_applied", "subscription_ramp_drafted", "subscription_ramp_updated", "subscription_moved_in", "subscription_moved_out", "subscription_movement_failed", "omnichannel_subscription_created", "omnichannel_subscription_item_renewed", "omnichannel_subscription_item_downgraded", "omnichannel_subscription_item_expired", "omnichannel_subscription_item_cancellation_scheduled", "omnichannel_subscription_item_scheduled_cancellation_removed", "omnichannel_subscription_item_resubscribed", "omnichannel_subscription_item_upgraded", "omnichannel_subscription_item_cancelled", "omnichannel_subscription_imported", "omnichannel_subscription_item_grace_period_started", "omnichannel_subscription_item_grace_period_expired", "omnichannel_subscription_item_dunning_started", "omnichannel_subscription_item_dunning_expired", "rule_created", "rule_updated", "rule_deleted", "record_purchase_failed", "omnichannel_subscription_item_change_scheduled", "omnichannel_subscription_item_scheduled_change_removed", "omnichannel_subscription_item_reactivated", "sales_order_created", "sales_order_updated", "omnichannel_subscription_item_changed", "omnichannel_subscription_item_paused", "omnichannel_subscription_item_resumed", "omnichannel_one_time_order_created", "omnichannel_one_time_order_item_cancelled", "omnichannel_subscription_item_pause_scheduled", "vault_token_created", "vault_token_updated", "vault_token_deleted" ],
                "pattern" : "^\\[(plan_created|plan_updated|plan_deleted|addon_created|addon_updated|addon_deleted|coupon_created|coupon_updated|coupon_deleted|coupon_set_created|coupon_set_updated|coupon_set_deleted|coupon_codes_added|coupon_codes_deleted|coupon_codes_updated|customer_created|customer_changed|customer_deleted|customer_moved_out|customer_moved_in|promotional_credits_added|promotional_credits_deducted|subscription_created|subscription_created_with_backdating|subscription_started|subscription_trial_end_reminder|subscription_activated|subscription_activated_with_backdating|subscription_changed|subscription_trial_extended|mrr_updated|subscription_changed_with_backdating|subscription_cancellation_scheduled|subscription_cancellation_reminder|subscription_cancelled|subscription_canceled_with_backdating|subscription_reactivated|subscription_reactivated_with_backdating|subscription_renewed|subscription_items_renewed|subscription_scheduled_cancellation_removed|subscription_changes_scheduled|subscription_scheduled_changes_removed|subscription_shipping_address_updated|subscription_deleted|subscription_paused|subscription_pause_scheduled|subscription_scheduled_pause_removed|subscription_resumed|subscription_resumption_scheduled|subscription_scheduled_resumption_removed|subscription_advance_invoice_schedule_added|subscription_advance_invoice_schedule_updated|subscription_advance_invoice_schedule_removed|pending_invoice_created|pending_invoice_updated|invoice_generated|invoice_generated_with_backdating|invoice_updated|invoice_deleted|credit_note_created|credit_note_created_with_backdating|credit_note_updated|credit_note_deleted|einvoice_created|einvoice_updated|subscription_renewal_reminder|transaction_created|transaction_updated|transaction_deleted|payment_succeeded|payment_failed|dunning_updated|payment_refunded|payment_initiated|refund_initiated|netd_payment_due_reminder|authorization_succeeded|authorization_voided|card_added|card_updated|card_expiry_reminder|card_expired|card_deleted|payment_source_added|payment_source_updated|payment_source_deleted|payment_source_expiring|payment_source_expired|payment_source_locally_deleted|virtual_bank_account_added|virtual_bank_account_updated|virtual_bank_account_deleted|token_created|token_consumed|token_expired|unbilled_charges_created|unbilled_charges_voided|unbilled_charges_deleted|unbilled_charges_invoiced|order_created|order_updated|order_cancelled|order_delivered|order_returned|order_ready_to_process|order_ready_to_ship|order_deleted|order_resent|quote_created|quote_updated|quote_deleted|tax_withheld_recorded|tax_withheld_deleted|tax_withheld_refunded|gift_scheduled|gift_unclaimed|gift_claimed|gift_expired|gift_cancelled|gift_updated|hierarchy_created|hierarchy_deleted|payment_intent_created|payment_intent_updated|contract_term_created|contract_term_renewed|contract_term_terminated|contract_term_completed|contract_term_cancelled|voucher_created|voucher_expired|voucher_create_failed|subscription_ramp_created|subscription_ramp_deleted|subscription_ramp_applied|subscription_ramp_drafted|subscription_ramp_updated|subscription_moved_in|subscription_moved_out|subscription_movement_failed|omnichannel_subscription_created|omnichannel_subscription_item_renewed|omnichannel_subscription_item_downgrade_scheduled|omnichannel_subscription_item_scheduled_downgrade_removed|omnichannel_subscription_item_downgraded|omnichannel_subscription_item_expired|omnichannel_subscription_item_cancellation_scheduled|omnichannel_subscription_item_scheduled_cancellation_removed|omnichannel_subscription_item_resubscribed|omnichannel_subscription_item_upgraded|omnichannel_subscription_item_cancelled|omnichannel_subscription_imported|omnichannel_subscription_item_grace_period_started|omnichannel_subscription_item_grace_period_expired|omnichannel_subscription_item_dunning_started|omnichannel_subscription_item_dunning_expired|rule_created|rule_updated|rule_deleted|record_purchase_failed|omnichannel_subscription_item_change_scheduled|omnichannel_subscription_item_scheduled_change_removed|omnichannel_subscription_item_reactivated|sales_order_created|sales_order_updated|omnichannel_subscription_item_changed|omnichannel_subscription_item_paused|omnichannel_subscription_item_resumed|omnichannel_one_time_order_created|omnichannel_one_time_order_item_cancelled|omnichannel_subscription_item_pause_scheduled|vault_token_created|vault_token_updated|vault_token_deleted)(,(plan_created|plan_updated|plan_deleted|addon_created|addon_updated|addon_deleted|coupon_created|coupon_updated|coupon_deleted|coupon_set_created|coupon_set_updated|coupon_set_deleted|coupon_codes_added|coupon_codes_deleted|coupon_codes_updated|customer_created|customer_changed|customer_deleted|customer_moved_out|customer_moved_in|promotional_credits_added|promotional_credits_deducted|subscription_created|subscription_created_with_backdating|subscription_started|subscription_trial_end_reminder|subscription_activated|subscription_activated_with_backdating|subscription_changed|subscription_trial_extended|mrr_updated|subscription_changed_with_backdating|subscription_cancellation_scheduled|subscription_cancellation_reminder|subscription_cancelled|subscription_canceled_with_backdating|subscription_reactivated|subscription_reactivated_with_backdating|subscription_renewed|subscription_items_renewed|subscription_scheduled_cancellation_removed|subscription_changes_scheduled|subscription_scheduled_changes_removed|subscription_shipping_address_updated|subscription_deleted|subscription_paused|subscription_pause_scheduled|subscription_scheduled_pause_removed|subscription_resumed|subscription_resumption_scheduled|subscription_scheduled_resumption_removed|subscription_advance_invoice_schedule_added|subscription_advance_invoice_schedule_updated|subscription_advance_invoice_schedule_removed|pending_invoice_created|pending_invoice_updated|invoice_generated|invoice_generated_with_backdating|invoice_updated|invoice_deleted|credit_note_created|credit_note_created_with_backdating|credit_note_updated|credit_note_deleted|einvoice_created|einvoice_updated|subscription_renewal_reminder|transaction_created|transaction_updated|transaction_deleted|payment_succeeded|payment_failed|dunning_updated|payment_refunded|payment_initiated|refund_initiated|netd_payment_due_reminder|authorization_succeeded|authorization_voided|card_added|card_updated|card_expiry_reminder|card_expired|card_deleted|payment_source_added|payment_source_updated|payment_source_deleted|payment_source_expiring|payment_source_expired|payment_source_locally_deleted|virtual_bank_account_added|virtual_bank_account_updated|virtual_bank_account_deleted|token_created|token_consumed|token_expired|unbilled_charges_created|unbilled_charges_voided|unbilled_charges_deleted|unbilled_charges_invoiced|order_created|order_updated|order_cancelled|order_delivered|order_returned|order_ready_to_process|order_ready_to_ship|order_deleted|order_resent|quote_created|quote_updated|quote_deleted|tax_withheld_recorded|tax_withheld_deleted|tax_withheld_refunded|gift_scheduled|gift_unclaimed|gift_claimed|gift_expired|gift_cancelled|gift_updated|hierarchy_created|hierarchy_deleted|payment_intent_created|payment_intent_updated|contract_term_created|contract_term_renewed|contract_term_terminated|contract_term_completed|contract_term_cancelled|voucher_created|voucher_expired|voucher_create_failed|subscription_ramp_created|subscription_ramp_deleted|subscription_ramp_applied|subscription_ramp_drafted|subscription_ramp_updated|subscription_moved_in|subscription_moved_out|subscription_movement_failed|omnichannel_subscription_created|omnichannel_subscription_item_renewed|omnichannel_subscription_item_downgrade_scheduled|omnichannel_subscription_item_scheduled_downgrade_removed|omnichannel_subscription_item_downgraded|omnichannel_subscription_item_expired|omnichannel_subscription_item_cancellation_scheduled|omnichannel_subscription_item_scheduled_cancellation_removed|omnichannel_subscription_item_resubscribed|omnichannel_subscription_item_upgraded|omnichannel_subscription_item_cancelled|omnichannel_subscription_imported|omnichannel_subscription_item_grace_period_started|omnichannel_subscription_item_grace_period_expired|omnichannel_subscription_item_dunning_started|omnichannel_subscription_item_dunning_expired|rule_created|rule_updated|rule_deleted|record_purchase_failed|omnichannel_subscription_item_change_scheduled|omnichannel_subscription_item_scheduled_change_removed|omnichannel_subscription_item_reactivated|sales_order_created|sales_order_updated|omnichannel_subscription_item_changed|omnichannel_subscription_item_paused|omnichannel_subscription_item_resumed|omnichannel_one_time_order_created|omnichannel_one_time_order_item_cancelled|omnichannel_subscription_item_pause_scheduled|vault_token_created|vault_token_updated|vault_token_deleted))*\\]$",
                "example" : null
              },
              "not_in" : {
                "type" : "string",
                "description" : "* `plan_created` - Sent when a plan is created. \n* `plan_updated` - Sent when a plan is changed. \n* `plan_deleted` - Sent when a plan is deleted. \n* `addon_created` - Sent when a addon is created. \n* `addon_updated` - Sent when a addon is changed. \n* `addon_deleted` - Sent when a addon is deleted. \n* `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* `subscription_renewal_reminder` - Sent before each subscription's renewal based on plan's period\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* `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* `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* `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* `omnichannel_subscription_item_pause_scheduled` - Triggered when an omnichannel subscription item scheduled for pause\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.",
                "enum" : [ "plan_created", "plan_updated", "plan_deleted", "addon_created", "addon_updated", "addon_deleted", "coupon_created", "coupon_updated", "coupon_deleted", "coupon_set_created", "coupon_set_updated", "coupon_set_deleted", "coupon_codes_added", "coupon_codes_deleted", "coupon_codes_updated", "customer_created", "customer_changed", "customer_deleted", "customer_moved_out", "customer_moved_in", "promotional_credits_added", "promotional_credits_deducted", "subscription_created", "subscription_created_with_backdating", "subscription_started", "subscription_trial_end_reminder", "subscription_activated", "subscription_activated_with_backdating", "subscription_changed", "subscription_trial_extended", "mrr_updated", "subscription_changed_with_backdating", "subscription_cancellation_scheduled", "subscription_cancellation_reminder", "subscription_cancelled", "subscription_canceled_with_backdating", "subscription_reactivated", "subscription_reactivated_with_backdating", "subscription_renewed", "subscription_items_renewed", "subscription_scheduled_cancellation_removed", "subscription_changes_scheduled", "subscription_scheduled_changes_removed", "subscription_shipping_address_updated", "subscription_deleted", "subscription_paused", "subscription_pause_scheduled", "subscription_scheduled_pause_removed", "subscription_resumed", "subscription_resumption_scheduled", "subscription_scheduled_resumption_removed", "subscription_advance_invoice_schedule_added", "subscription_advance_invoice_schedule_updated", "subscription_advance_invoice_schedule_removed", "pending_invoice_created", "pending_invoice_updated", "invoice_generated", "invoice_generated_with_backdating", "invoice_updated", "invoice_deleted", "credit_note_created", "credit_note_created_with_backdating", "credit_note_updated", "credit_note_deleted", "einvoice_created", "einvoice_updated", "subscription_renewal_reminder", "transaction_created", "transaction_updated", "transaction_deleted", "payment_succeeded", "payment_failed", "dunning_updated", "payment_refunded", "payment_initiated", "refund_initiated", "authorization_succeeded", "authorization_voided", "card_added", "card_updated", "card_expiry_reminder", "card_expired", "card_deleted", "payment_source_added", "payment_source_updated", "payment_source_deleted", "payment_source_expiring", "payment_source_expired", "payment_source_locally_deleted", "virtual_bank_account_added", "virtual_bank_account_updated", "virtual_bank_account_deleted", "token_created", "token_consumed", "token_expired", "unbilled_charges_created", "unbilled_charges_voided", "unbilled_charges_deleted", "unbilled_charges_invoiced", "order_created", "order_updated", "order_cancelled", "order_delivered", "order_returned", "order_ready_to_process", "order_ready_to_ship", "order_deleted", "order_resent", "quote_created", "quote_updated", "quote_deleted", "tax_withheld_recorded", "tax_withheld_deleted", "tax_withheld_refunded", "gift_scheduled", "gift_unclaimed", "gift_claimed", "gift_expired", "gift_cancelled", "gift_updated", "hierarchy_created", "hierarchy_deleted", "payment_intent_created", "payment_intent_updated", "contract_term_created", "contract_term_renewed", "contract_term_terminated", "contract_term_completed", "contract_term_cancelled", "voucher_created", "voucher_expired", "voucher_create_failed", "subscription_ramp_created", "subscription_ramp_deleted", "subscription_ramp_applied", "subscription_ramp_drafted", "subscription_ramp_updated", "subscription_moved_in", "subscription_moved_out", "subscription_movement_failed", "omnichannel_subscription_created", "omnichannel_subscription_item_renewed", "omnichannel_subscription_item_downgraded", "omnichannel_subscription_item_expired", "omnichannel_subscription_item_cancellation_scheduled", "omnichannel_subscription_item_scheduled_cancellation_removed", "omnichannel_subscription_item_resubscribed", "omnichannel_subscription_item_upgraded", "omnichannel_subscription_item_cancelled", "omnichannel_subscription_imported", "omnichannel_subscription_item_grace_period_started", "omnichannel_subscription_item_grace_period_expired", "omnichannel_subscription_item_dunning_started", "omnichannel_subscription_item_dunning_expired", "rule_created", "rule_updated", "rule_deleted", "record_purchase_failed", "omnichannel_subscription_item_change_scheduled", "omnichannel_subscription_item_scheduled_change_removed", "omnichannel_subscription_item_reactivated", "sales_order_created", "sales_order_updated", "omnichannel_subscription_item_changed", "omnichannel_subscription_item_paused", "omnichannel_subscription_item_resumed", "omnichannel_one_time_order_created", "omnichannel_one_time_order_item_cancelled", "omnichannel_subscription_item_pause_scheduled", "vault_token_created", "vault_token_updated", "vault_token_deleted" ],
                "pattern" : "^\\[(plan_created|plan_updated|plan_deleted|addon_created|addon_updated|addon_deleted|coupon_created|coupon_updated|coupon_deleted|coupon_set_created|coupon_set_updated|coupon_set_deleted|coupon_codes_added|coupon_codes_deleted|coupon_codes_updated|customer_created|customer_changed|customer_deleted|customer_moved_out|customer_moved_in|promotional_credits_added|promotional_credits_deducted|subscription_created|subscription_created_with_backdating|subscription_started|subscription_trial_end_reminder|subscription_activated|subscription_activated_with_backdating|subscription_changed|subscription_trial_extended|mrr_updated|subscription_changed_with_backdating|subscription_cancellation_scheduled|subscription_cancellation_reminder|subscription_cancelled|subscription_canceled_with_backdating|subscription_reactivated|subscription_reactivated_with_backdating|subscription_renewed|subscription_items_renewed|subscription_scheduled_cancellation_removed|subscription_changes_scheduled|subscription_scheduled_changes_removed|subscription_shipping_address_updated|subscription_deleted|subscription_paused|subscription_pause_scheduled|subscription_scheduled_pause_removed|subscription_resumed|subscription_resumption_scheduled|subscription_scheduled_resumption_removed|subscription_advance_invoice_schedule_added|subscription_advance_invoice_schedule_updated|subscription_advance_invoice_schedule_removed|pending_invoice_created|pending_invoice_updated|invoice_generated|invoice_generated_with_backdating|invoice_updated|invoice_deleted|credit_note_created|credit_note_created_with_backdating|credit_note_updated|credit_note_deleted|einvoice_created|einvoice_updated|subscription_renewal_reminder|transaction_created|transaction_updated|transaction_deleted|payment_succeeded|payment_failed|dunning_updated|payment_refunded|payment_initiated|refund_initiated|netd_payment_due_reminder|authorization_succeeded|authorization_voided|card_added|card_updated|card_expiry_reminder|card_expired|card_deleted|payment_source_added|payment_source_updated|payment_source_deleted|payment_source_expiring|payment_source_expired|payment_source_locally_deleted|virtual_bank_account_added|virtual_bank_account_updated|virtual_bank_account_deleted|token_created|token_consumed|token_expired|unbilled_charges_created|unbilled_charges_voided|unbilled_charges_deleted|unbilled_charges_invoiced|order_created|order_updated|order_cancelled|order_delivered|order_returned|order_ready_to_process|order_ready_to_ship|order_deleted|order_resent|quote_created|quote_updated|quote_deleted|tax_withheld_recorded|tax_withheld_deleted|tax_withheld_refunded|gift_scheduled|gift_unclaimed|gift_claimed|gift_expired|gift_cancelled|gift_updated|hierarchy_created|hierarchy_deleted|payment_intent_created|payment_intent_updated|contract_term_created|contract_term_renewed|contract_term_terminated|contract_term_completed|contract_term_cancelled|voucher_created|voucher_expired|voucher_create_failed|subscription_ramp_created|subscription_ramp_deleted|subscription_ramp_applied|subscription_ramp_drafted|subscription_ramp_updated|subscription_moved_in|subscription_moved_out|subscription_movement_failed|omnichannel_subscription_created|omnichannel_subscription_item_renewed|omnichannel_subscription_item_downgrade_scheduled|omnichannel_subscription_item_scheduled_downgrade_removed|omnichannel_subscription_item_downgraded|omnichannel_subscription_item_expired|omnichannel_subscription_item_cancellation_scheduled|omnichannel_subscription_item_scheduled_cancellation_removed|omnichannel_subscription_item_resubscribed|omnichannel_subscription_item_upgraded|omnichannel_subscription_item_cancelled|omnichannel_subscription_imported|omnichannel_subscription_item_grace_period_started|omnichannel_subscription_item_grace_period_expired|omnichannel_subscription_item_dunning_started|omnichannel_subscription_item_dunning_expired|rule_created|rule_updated|rule_deleted|record_purchase_failed|omnichannel_subscription_item_change_scheduled|omnichannel_subscription_item_scheduled_change_removed|omnichannel_subscription_item_reactivated|sales_order_created|sales_order_updated|omnichannel_subscription_item_changed|omnichannel_subscription_item_paused|omnichannel_subscription_item_resumed|omnichannel_one_time_order_created|omnichannel_one_time_order_item_cancelled|omnichannel_subscription_item_pause_scheduled|vault_token_created|vault_token_updated|vault_token_deleted)(,(plan_created|plan_updated|plan_deleted|addon_created|addon_updated|addon_deleted|coupon_created|coupon_updated|coupon_deleted|coupon_set_created|coupon_set_updated|coupon_set_deleted|coupon_codes_added|coupon_codes_deleted|coupon_codes_updated|customer_created|customer_changed|customer_deleted|customer_moved_out|customer_moved_in|promotional_credits_added|promotional_credits_deducted|subscription_created|subscription_created_with_backdating|subscription_started|subscription_trial_end_reminder|subscription_activated|subscription_activated_with_backdating|subscription_changed|subscription_trial_extended|mrr_updated|subscription_changed_with_backdating|subscription_cancellation_scheduled|subscription_cancellation_reminder|subscription_cancelled|subscription_canceled_with_backdating|subscription_reactivated|subscription_reactivated_with_backdating|subscription_renewed|subscription_items_renewed|subscription_scheduled_cancellation_removed|subscription_changes_scheduled|subscription_scheduled_changes_removed|subscription_shipping_address_updated|subscription_deleted|subscription_paused|subscription_pause_scheduled|subscription_scheduled_pause_removed|subscription_resumed|subscription_resumption_scheduled|subscription_scheduled_resumption_removed|subscription_advance_invoice_schedule_added|subscription_advance_invoice_schedule_updated|subscription_advance_invoice_schedule_removed|pending_invoice_created|pending_invoice_updated|invoice_generated|invoice_generated_with_backdating|invoice_updated|invoice_deleted|credit_note_created|credit_note_created_with_backdating|credit_note_updated|credit_note_deleted|einvoice_created|einvoice_updated|subscription_renewal_reminder|transaction_created|transaction_updated|transaction_deleted|payment_succeeded|payment_failed|dunning_updated|payment_refunded|payment_initiated|refund_initiated|netd_payment_due_reminder|authorization_succeeded|authorization_voided|card_added|card_updated|card_expiry_reminder|card_expired|card_deleted|payment_source_added|payment_source_updated|payment_source_deleted|payment_source_expiring|payment_source_expired|payment_source_locally_deleted|virtual_bank_account_added|virtual_bank_account_updated|virtual_bank_account_deleted|token_created|token_consumed|token_expired|unbilled_charges_created|unbilled_charges_voided|unbilled_charges_deleted|unbilled_charges_invoiced|order_created|order_updated|order_cancelled|order_delivered|order_returned|order_ready_to_process|order_ready_to_ship|order_deleted|order_resent|quote_created|quote_updated|quote_deleted|tax_withheld_recorded|tax_withheld_deleted|tax_withheld_refunded|gift_scheduled|gift_unclaimed|gift_claimed|gift_expired|gift_cancelled|gift_updated|hierarchy_created|hierarchy_deleted|payment_intent_created|payment_intent_updated|contract_term_created|contract_term_renewed|contract_term_terminated|contract_term_completed|contract_term_cancelled|voucher_created|voucher_expired|voucher_create_failed|subscription_ramp_created|subscription_ramp_deleted|subscription_ramp_applied|subscription_ramp_drafted|subscription_ramp_updated|subscription_moved_in|subscription_moved_out|subscription_movement_failed|omnichannel_subscription_created|omnichannel_subscription_item_renewed|omnichannel_subscription_item_downgrade_scheduled|omnichannel_subscription_item_scheduled_downgrade_removed|omnichannel_subscription_item_downgraded|omnichannel_subscription_item_expired|omnichannel_subscription_item_cancellation_scheduled|omnichannel_subscription_item_scheduled_cancellation_removed|omnichannel_subscription_item_resubscribed|omnichannel_subscription_item_upgraded|omnichannel_subscription_item_cancelled|omnichannel_subscription_imported|omnichannel_subscription_item_grace_period_started|omnichannel_subscription_item_grace_period_expired|omnichannel_subscription_item_dunning_started|omnichannel_subscription_item_dunning_expired|rule_created|rule_updated|rule_deleted|record_purchase_failed|omnichannel_subscription_item_change_scheduled|omnichannel_subscription_item_scheduled_change_removed|omnichannel_subscription_item_reactivated|sales_order_created|sales_order_updated|omnichannel_subscription_item_changed|omnichannel_subscription_item_paused|omnichannel_subscription_item_resumed|omnichannel_one_time_order_created|omnichannel_one_time_order_item_cancelled|omnichannel_subscription_item_pause_scheduled|vault_token_created|vault_token_updated|vault_token_deleted))*\\]$",
                "example" : null
              }
            }
          }
        }, {
          "name" : "source",
          "in" : "query",
          "description" : "optional, enumerated string filter\n\nSource of the event. Possible values are : admin_console, api, scheduled_job, hosted_page, portal, system, none, js_api, migration, bulk_operation, external_service.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*source\\[is\\] = \"hosted_page\"*\n",
          "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\n* `api` - Operation made through the API\n* `scheduled_job` - Operation made through the Scheduled Jobs\n* `hosted_page` - Operation made through the Hosted Pages\n* `portal` - Operation made through [Self-Serve Portal](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html)\n* `system` - Operation that are triggered by ChargeBee System\n* `none` - If no source can be identified for an operation\n* `js_api` - Operation made through the JS API\n* `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).\n* `bulk_operation` - Operation that are triggerd through bulk operation.\n* `external_service` - Operation that are triggered via webhook\n",
                "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\n* `api` - Operation made through the API\n* `scheduled_job` - Operation made through the Scheduled Jobs\n* `hosted_page` - Operation made through the Hosted Pages\n* `portal` - Operation made through [Self-Serve Portal](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html)\n* `system` - Operation that are triggered by ChargeBee System\n* `none` - If no source can be identified for an operation\n* `js_api` - Operation made through the JS API\n* `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).\n* `bulk_operation` - Operation that are triggerd through bulk operation.\n* `external_service` - Operation that are triggered via webhook\n",
                "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\n* `api` - Operation made through the API\n* `scheduled_job` - Operation made through the Scheduled Jobs\n* `hosted_page` - Operation made through the Hosted Pages\n* `portal` - Operation made through [Self-Serve Portal](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html)\n* `system` - Operation that are triggered by ChargeBee System\n* `none` - If no source can be identified for an operation\n* `js_api` - Operation made through the JS API\n* `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).\n* `bulk_operation` - Operation that are triggerd through bulk operation.\n* `external_service` - Operation that are triggered via webhook\n",
                "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\n* `api` - Operation made through the API\n* `scheduled_job` - Operation made through the Scheduled Jobs\n* `hosted_page` - Operation made through the Hosted Pages\n* `portal` - Operation made through [Self-Serve Portal](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html)\n* `system` - Operation that are triggered by ChargeBee System\n* `none` - If no source can be identified for an operation\n* `js_api` - Operation made through the JS API\n* `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).\n* `bulk_operation` - Operation that are triggerd through bulk operation.\n* `external_service` - Operation that are triggered via webhook\n",
                "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\n\nTimestamp indicating when this event had occurred.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*occurred_at\\[before\\] = \"1349116200\"*\n",
          "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\n\nSorts based on the specified attribute.\n**Supported attributes :**\noccurred_at\n\n**Supported sort-orders :**\nasc, desc\n\n**Example →**\n*sort_by\\[asc\\] = \"occurred_at\"*\n\nThis will sort the result based on the 'occurred_at' attribute in ascending(earliest first) order.\n",
          "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`.\n",
                      "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" : "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\n"
                    }
                  },
                  "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.\n\nOnly the comments that are added via Admin console and API can be deleted. Chargebee generated \"System\" comments cannot be deleted.\n",
        "operationId" : "delete_a_comment",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "comment-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/comment-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "comment" : {
                      "$ref" : "#/components/schemas/Comment",
                      "description" : "Resource object representing comment\n"
                    }
                  },
                  "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.\n",
        "operationId" : "retrieve_a_comment",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "comment-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/comment-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "comment" : {
                      "$ref" : "#/components/schemas/Comment",
                      "description" : "Resource object representing comment\n"
                    }
                  },
                  "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.\n\nIf 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.\n",
        "operationId" : "list_comments",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "limit",
          "in" : "query",
          "description" : "The number of resources to be returned.\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`\nto the value of `next_offset`\nobtained in the previous iteration of the API call.\n",
          "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.\n\n* order - Entity that represents an order\n* customer - Entity that represents a customer\n* invoice - Invoice description\n* business_entity - Entity that represents item of type business entity\n* plan - Entity that represents a subscription plan\n* coupon - Entity that represents a discount coupon\n* subscription - Entity that represents a subscription of a customer\n* transaction - Entity that represents a transaction.\n* addon - Entity that represents an addon\n* credit_note - Credit note description\n* quote - Entity that represents a quote\n",
          "required" : false,
          "deprecated" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "deprecated" : false,
            "enum" : [ "customer", "subscription", "invoice", "quote", "credit_note", "transaction", "plan", "addon", "coupon", "order", "business_entity" ],
            "example" : null
          }
        }, {
          "name" : "entity_id",
          "in" : "query",
          "description" : "Unique identifier of the entity.\n",
          "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\n\nThe time at which this comment was created.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*created_at\\[after\\] = \"1456332678\"*\n",
          "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\n\nSorts based on the specified attribute.\n**Supported attributes :**\ncreated_at\n\n**Supported sort-orders :**\nasc, desc\n\n**Example →**\n*sort_by\\[asc\\] = \"created_at\"*\n\nThis will sort the result based on the 'created_at' attribute in ascending(earliest first) order.\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" : {
                          "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`.\n",
                      "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.\n",
        "operationId" : "create_a_comment",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "entity_type" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Type of the entity to create the comment for.\n\n* order - Entity that represents an order\n* customer - Entity that represents a customer\n* invoice - Invoice description\n* business_entity - Entity that represents item of type business entity\n* plan - Entity that represents a subscription plan\n* coupon - Entity that represents a discount coupon\n* subscription - Entity that represents a subscription of a customer\n* transaction - Entity that represents a transaction.\n* addon - Entity that represents an addon\n* credit_note - Credit note description\n* quote - Entity that represents a quote\n",
                    "enum" : [ "customer", "subscription", "invoice", "quote", "credit_note", "transaction", "plan", "addon", "coupon", "order", "business_entity" ],
                    "example" : null
                  },
                  "entity_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Unique identifier of the entity.\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "notes" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Actual notes for the comment.\n",
                    "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.\n",
                    "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\n"
                    }
                  },
                  "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.\n",
        "operationId" : "create_a_portal_session",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "redirect_url" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "URL to redirect when the user logs out from the portal.\n",
                    "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.\n\n**Note:**\nThis parameter is not applicable for [in-app](https://www.chargebee.com/docs/v3-self-serve-portal.html)\nportal.\n",
                    "maxLength" : 250,
                    "example" : null
                  },
                  "customer" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for customer\n",
                    "properties" : {
                      "id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Identifier of the customer.\n",
                        "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\n"
                    }
                  },
                  "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:\n\n* **auth_session_id** - this should be sent as part of the endpoint.\n* **auth_session_token** - this should be sent as value for the input parameter **token**.\n\n**Note:** This API is not applicable for [in-app](https://www.chargebee.com/docs/v3-self-serve-portal.html) portal.\n",
        "operationId" : "activate_a_portal_session",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "portal-session-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/portal-session-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "token" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Unique pre-authenticated portal session token to access customer portal directly.\n",
                    "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\n"
                    }
                  },
                  "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.\n\nIf this API is called for a Portal Session that currently is in :\n\n* \"created\" status, the session status will be marked as \"logged_out\" and the access URL will become invalid.\n* \"logged_in\" status, the session status will be marked as \"logged_out\" and customer will not be able to use that session.\n* \"logged_out\" status, this will return normally without changing any attribute of this resource.\n",
        "operationId" : "logout_a_portal_session",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "portal-session-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/portal-session-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "portal_session" : {
                      "$ref" : "#/components/schemas/PortalSession",
                      "description" : "Resource object representing portal_session\n"
                    }
                  },
                  "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`\nas a path parameter.\n",
        "operationId" : "retrieve_a_portal_session",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "portal-session-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/portal-session-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "portal_session" : {
                      "$ref" : "#/components/schemas/PortalSession",
                      "description" : "Resource object representing portal_session\n"
                    }
                  },
                  "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.\n",
        "operationId" : "list_site_migration_details",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "limit",
          "in" : "query",
          "description" : "The number of resources to be returned.\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`\nto the value of `next_offset`\nobtained in the previous iteration of the API call.\n",
          "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\n\nEntity Id of the record in the other site.\n**Supported operators :**\nis, is_not, starts_with\n\n**Example →**\n*entity_id_at_other_site\\[is\\] = \"null\"*\n",
          "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\n\nSite name to which the record is moved in/out.\n**Supported operators :**\nis, is_not, starts_with\n\n**Example →**\n*other_site_name\\[is_not\\] = \"acme-test\"*\n",
          "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\n\nId of the entity in this site.\n**Supported operators :**\nis, is_not, starts_with\n\n**Example →**\n*entity_id\\[is\\] = \"8axqwer7as\"*\n",
          "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\n\nEntity Type of the record. Possible values are : customer, subscription, invoice, credit_note, transaction, order.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*entity_type\\[is\\] = \"customer\"*\n",
          "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\n* `subscription` - Entity that represents a subscription of a customer\n* `invoice` - Invoice\n* `credit_note` - Credit note\n* `transaction` - Entity that represents a transaction.\n* `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\n* `subscription` - Entity that represents a subscription of a customer\n* `invoice` - Invoice\n* `credit_note` - Credit note\n* `transaction` - Entity that represents a transaction.\n* `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\n* `subscription` - Entity that represents a subscription of a customer\n* `invoice` - Invoice\n* `credit_note` - Credit note\n* `transaction` - Entity that represents a transaction.\n* `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\n* `subscription` - Entity that represents a subscription of a customer\n* `invoice` - Invoice\n* `credit_note` - Credit note\n* `transaction` - Entity that represents a transaction.\n* `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\n\nStatus of the migration. Possible values are : moved_in, moved_out, moving_out.\n\n**Supported operators :**\nis, is_not, in, not_in\n\n**Example →**\n*status\\[is\\] = \"MOVED_OUT\"*\n",
          "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\n* `moved_out` - Moved out from one cb site to another\n* `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\n* `moved_out` - Moved out from one cb site to another\n* `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\n* `moved_out` - Moved out from one cb site to another\n* `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\n* `moved_out` - Moved out from one cb site to another\n* `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`.\n",
                      "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.\n",
        "operationId" : "retrieve_latest_migration_details",
        "parameters" : [ {
          "name" : "from_site",
          "in" : "query",
          "description" : "Domain name to which the item is moved.\n",
          "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.\n\n* customer - Entity that represents a customer\n",
          "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.\n",
          "required" : true,
          "deprecated" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 100,
            "example" : null
          }
        }, {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "resource_migration" : {
                      "$ref" : "#/components/schemas/ResourceMigration",
                      "description" : "Resource object representing resource_migration\n"
                    }
                  },
                  "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'.\n",
        "operationId" : "retrieve_a_time_machine",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "time-machine-name",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/time-machine-name",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "time_machine" : {
                      "$ref" : "#/components/schemas/TimeMachine",
                      "description" : "Resource object representing time_machine\n"
                    }
                  },
                  "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**\n.\nYou need to check if the \"start afresh\" operation has completed by checking if the time travel status is **successful**\nby retrieving the time machine in a loop with a minimum delay of 3 secs between two retrieve requests.\nUse 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.\n",
        "operationId" : "travel_forward",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "time-machine-name",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/time-machine-name",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "destination_time" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "The **time**\nto travel to. Should be between the 'current' destination time of the time machine and present time.\n",
                    "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\n"
                    }
                  },
                  "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.\n\n**Note:**\nThis API call is asynchronous.\nYou need to check if the \"start afresh\" operation has completed by checking if the time travel status is **successful**\nby 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**\nfunction provided as a instance method in the library.\nUse 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.\n",
        "operationId" : "start_afresh",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "time-machine-name",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/time-machine-name",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "genesis_time" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "The genesis time to travel back as part of the reset operation. If not provided, then the travel is set to 6 months in the past.\n\n**Note:**\nCan only be in the past.\n",
                    "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\n"
                    }
                  },
                  "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.\n",
        "operationId" : "export_customers",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "export_type" : {
                    "type" : "string",
                    "default" : "data",
                    "deprecated" : false,
                    "description" : "Determines the format of the data. Returns the export type based on the selected value.\n\n* data - Provides the full set of data for the customers in multiple `.csv` files.\n* 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).\n",
                    "enum" : [ "data", "import_friendly_data" ],
                    "example" : null
                  },
                  "business_entity_id" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "optional, string filter\n\nThe ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity.  \n**Note**\n\n[Multiple Business Entities](/docs/api/getting-started) is a feature available only on Product Catalog 2.0.\n\n**Supported operators :**\nis, is_not, starts_with\n\n**Example →**\n*business_entity_id\\[is\\] = \"business_entity_id\"*\n",
                    "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\n",
                    "properties" : {
                      "id" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "Identifier of the customer.\n",
                        "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\n",
                        "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\n",
                        "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.\n",
                        "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.\n",
                        "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\n",
                        "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\n",
                        "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.\n* `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.\n* `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.\n* `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.\n* `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.\n",
                        "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.\n* `exempt` -\n  * 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.\n  * 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.\n* `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.\n",
                            "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.\n* `exempt` -\n  * 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.\n  * 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.\n* `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.\n",
                            "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.\n* `exempt` -\n  * 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.\n  * 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.\n* `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.\n",
                            "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.\n* `exempt` -\n  * 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.\n  * 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.\n* `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.\n",
                            "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.\n",
                        "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`.\nThis 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`\ninput parameter as `updated_at`\nfor a faster response.\n",
                        "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.\n",
                        "example" : "cash",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "description" : "* `no_preference` - No Preference\n* `cash` - Cash\n* `check` - Check\n* `bank_transfer` - Bank Transfer\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `boleto` - Boleto\n* `us_automated_bank_transfer` - US Automated Bank Transfer\n* `eu_automated_bank_transfer` - EU Automated Bank Transfer\n* `uk_automated_bank_transfer` - UK Automated Bank Transfer\n* `jp_automated_bank_transfer` - JP Automated Bank Transfer\n* `mx_automated_bank_transfer` - MX Automated Bank Transfer\n* `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\n* `cash` - Cash\n* `check` - Check\n* `bank_transfer` - Bank Transfer\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `boleto` - Boleto\n* `us_automated_bank_transfer` - US Automated Bank Transfer\n* `eu_automated_bank_transfer` - EU Automated Bank Transfer\n* `uk_automated_bank_transfer` - UK Automated Bank Transfer\n* `jp_automated_bank_transfer` - JP Automated Bank Transfer\n* `mx_automated_bank_transfer` - MX Automated Bank Transfer\n* `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\n* `cash` - Cash\n* `check` - Check\n* `bank_transfer` - Bank Transfer\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `boleto` - Boleto\n* `us_automated_bank_transfer` - US Automated Bank Transfer\n* `eu_automated_bank_transfer` - EU Automated Bank Transfer\n* `uk_automated_bank_transfer` - UK Automated Bank Transfer\n* `jp_automated_bank_transfer` - JP Automated Bank Transfer\n* `mx_automated_bank_transfer` - MX Automated Bank Transfer\n* `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\n* `cash` - Cash\n* `check` - Check\n* `bank_transfer` - Bank Transfer\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `boleto` - Boleto\n* `us_automated_bank_transfer` - US Automated Bank Transfer\n* `eu_automated_bank_transfer` - EU Automated Bank Transfer\n* `uk_automated_bank_transfer` - UK Automated Bank Transfer\n* `jp_automated_bank_transfer` - JP Automated Bank Transfer\n* `mx_automated_bank_transfer` - MX Automated Bank Transfer\n* `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)\nfor 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)\nwhich takes precedence.\n",
                        "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.\n",
                        "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\n",
                    "properties" : {
                      "parent_id" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "Immediate parent with whom we will link our new customer(child)\n",
                        "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\n",
                        "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\n",
                        "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\n"
                    }
                  },
                  "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.\n",
        "operationId" : "export_transactions",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "transaction" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for transaction\n",
                    "properties" : {
                      "id" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "Uniquely identifies the transaction.\n",
                        "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\n",
                        "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.\n",
                        "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.\n",
                        "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\n",
                        "example" : "card",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "description" : "* `card` - Card\n* `cash` - Cash\n* `check` - Check\n* `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).\n* `bank_transfer` - Bank Transfer\n* `amazon_payments` - Amazon Payments\n* `paypal_express_checkout` - Paypal Express Checkout\n* `direct_debit` - Direct Debit\n* `alipay` - Alipay\n* `unionpay` - Unionpay\n* `apple_pay` - Apple Pay\n* `wechat_pay` - WeChat Pay\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `ideal` - IDEAL\n* `google_pay` - Google Pay\n* `sofort` - Sofort\n* `bancontact` - Bancontact\n* `giropay` - giropay\n* `dotpay` - Dotpay\n* `other` - Payment Methods other than the above types\n* `app_store` - **(Deprecated)** App Store\n* `upi` - upi\n* `netbanking_emandates` - netbanking_emandates\n* `play_store` - **(Deprecated)** Play Store\n* `custom` - Custom\n* `boleto` - boleto\n* `venmo` - Venmo\n* `pay_to` - PayTo\n* `faster_payments` - Faster Payments\n* `sepa_instant_transfer` - Sepa Instant Transfer\n* `automated_bank_transfer` - Automated Bank Transfer\n* `klarna_pay_now` - Klarna Pay Now\n* `online_banking_poland` - Online Banking Poland\n* `payconiq_by_bancontact` - Payconiq by Bancontact\n* `electronic_payment_standard` - Payments made via Electronic Payment Standard.\n* `kbc_payment_button` - Payments made via KBC Payment Button.\n* `pay_by_bank` - Payments made via Pay By Bank.\n* `trustly` - Payments made via Trustly.\n* `stablecoin` - Stablecoin\n* `kakao_pay` - Kakao Pay\n* `naver_pay` - Naver Pay\n* `revolut_pay` - Revolut Pay\n* `cash_app_pay` - Cash App Pay\n* `pix` - Payments made via Pix\n* `twint` - Twint\n* `go_pay` - Go Pay\n* `grab_pay` - Grab Pay\n* `pay_co` - Pay Co\n* `after_pay` - After Pay\n* `swish` - Swish\n* `payme` - PayMe\n* `klarna` - Payments made via Klarna\n* `alipay_hk` - Alipay HK\n* `paypay` - PayPay\n* `gcash` - GCash\n* `south_korean_cards` - Payments made via South Korean Cards\n* `paynow` - Payments made via PayNow\n* `bizum` - Payments made via Bizum\n* `promptpay` - Payments made via PromptPay\n* `dana` - Dana\n* `touch_n_go` - Touch 'n Go\n* `tamara` - Tamara\n* `qpay` - Qpay\n* `ovo` - OVO\n* `momo` - MoMo\n* `mercado_pago` - Mercado Pago\n* `nequi` - Nequi\n* `nupay` - NuPay\n* `picpay` - PicPay\n* `thai_qr` - Thai QR\n* `blik` - BLIK\n* `fpx` - FPX\n* `wero` - Wero\n* `p24` - Przelewy24 (P24)\n* `affirm_pay` - Affirm Pay\n* `rakuten_pay` - Rakuten Pay\n",
                            "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\n* `cash` - Cash\n* `check` - Check\n* `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).\n* `bank_transfer` - Bank Transfer\n* `amazon_payments` - Amazon Payments\n* `paypal_express_checkout` - Paypal Express Checkout\n* `direct_debit` - Direct Debit\n* `alipay` - Alipay\n* `unionpay` - Unionpay\n* `apple_pay` - Apple Pay\n* `wechat_pay` - WeChat Pay\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `ideal` - IDEAL\n* `google_pay` - Google Pay\n* `sofort` - Sofort\n* `bancontact` - Bancontact\n* `giropay` - giropay\n* `dotpay` - Dotpay\n* `other` - Payment Methods other than the above types\n* `app_store` - **(Deprecated)** App Store\n* `upi` - upi\n* `netbanking_emandates` - netbanking_emandates\n* `play_store` - **(Deprecated)** Play Store\n* `custom` - Custom\n* `boleto` - boleto\n* `venmo` - Venmo\n* `pay_to` - PayTo\n* `faster_payments` - Faster Payments\n* `sepa_instant_transfer` - Sepa Instant Transfer\n* `automated_bank_transfer` - Automated Bank Transfer\n* `klarna_pay_now` - Klarna Pay Now\n* `online_banking_poland` - Online Banking Poland\n* `payconiq_by_bancontact` - Payconiq by Bancontact\n* `electronic_payment_standard` - Payments made via Electronic Payment Standard.\n* `kbc_payment_button` - Payments made via KBC Payment Button.\n* `pay_by_bank` - Payments made via Pay By Bank.\n* `trustly` - Payments made via Trustly.\n* `stablecoin` - Stablecoin\n* `kakao_pay` - Kakao Pay\n* `naver_pay` - Naver Pay\n* `revolut_pay` - Revolut Pay\n* `cash_app_pay` - Cash App Pay\n* `pix` - Payments made via Pix\n* `twint` - Twint\n* `go_pay` - Go Pay\n* `grab_pay` - Grab Pay\n* `pay_co` - Pay Co\n* `after_pay` - After Pay\n* `swish` - Swish\n* `payme` - PayMe\n* `klarna` - Payments made via Klarna\n* `alipay_hk` - Alipay HK\n* `paypay` - PayPay\n* `gcash` - GCash\n* `south_korean_cards` - Payments made via South Korean Cards\n* `paynow` - Payments made via PayNow\n* `bizum` - Payments made via Bizum\n* `promptpay` - Payments made via PromptPay\n* `dana` - Dana\n* `touch_n_go` - Touch 'n Go\n* `tamara` - Tamara\n* `qpay` - Qpay\n* `ovo` - OVO\n* `momo` - MoMo\n* `mercado_pago` - Mercado Pago\n* `nequi` - Nequi\n* `nupay` - NuPay\n* `picpay` - PicPay\n* `thai_qr` - Thai QR\n* `blik` - BLIK\n* `fpx` - FPX\n* `wero` - Wero\n* `p24` - Przelewy24 (P24)\n* `affirm_pay` - Affirm Pay\n* `rakuten_pay` - Rakuten Pay\n",
                            "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\n* `cash` - Cash\n* `check` - Check\n* `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).\n* `bank_transfer` - Bank Transfer\n* `amazon_payments` - Amazon Payments\n* `paypal_express_checkout` - Paypal Express Checkout\n* `direct_debit` - Direct Debit\n* `alipay` - Alipay\n* `unionpay` - Unionpay\n* `apple_pay` - Apple Pay\n* `wechat_pay` - WeChat Pay\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `ideal` - IDEAL\n* `google_pay` - Google Pay\n* `sofort` - Sofort\n* `bancontact` - Bancontact\n* `giropay` - giropay\n* `dotpay` - Dotpay\n* `other` - Payment Methods other than the above types\n* `app_store` - **(Deprecated)** App Store\n* `upi` - upi\n* `netbanking_emandates` - netbanking_emandates\n* `play_store` - **(Deprecated)** Play Store\n* `custom` - Custom\n* `boleto` - boleto\n* `venmo` - Venmo\n* `pay_to` - PayTo\n* `faster_payments` - Faster Payments\n* `sepa_instant_transfer` - Sepa Instant Transfer\n* `automated_bank_transfer` - Automated Bank Transfer\n* `klarna_pay_now` - Klarna Pay Now\n* `online_banking_poland` - Online Banking Poland\n* `payconiq_by_bancontact` - Payconiq by Bancontact\n* `electronic_payment_standard` - Payments made via Electronic Payment Standard.\n* `kbc_payment_button` - Payments made via KBC Payment Button.\n* `pay_by_bank` - Payments made via Pay By Bank.\n* `trustly` - Payments made via Trustly.\n* `stablecoin` - Stablecoin\n* `kakao_pay` - Kakao Pay\n* `naver_pay` - Naver Pay\n* `revolut_pay` - Revolut Pay\n* `cash_app_pay` - Cash App Pay\n* `pix` - Payments made via Pix\n* `twint` - Twint\n* `go_pay` - Go Pay\n* `grab_pay` - Grab Pay\n* `pay_co` - Pay Co\n* `after_pay` - After Pay\n* `swish` - Swish\n* `payme` - PayMe\n* `klarna` - Payments made via Klarna\n* `alipay_hk` - Alipay HK\n* `paypay` - PayPay\n* `gcash` - GCash\n* `south_korean_cards` - Payments made via South Korean Cards\n* `paynow` - Payments made via PayNow\n* `bizum` - Payments made via Bizum\n* `promptpay` - Payments made via PromptPay\n* `dana` - Dana\n* `touch_n_go` - Touch 'n Go\n* `tamara` - Tamara\n* `qpay` - Qpay\n* `ovo` - OVO\n* `momo` - MoMo\n* `mercado_pago` - Mercado Pago\n* `nequi` - Nequi\n* `nupay` - NuPay\n* `picpay` - PicPay\n* `thai_qr` - Thai QR\n* `blik` - BLIK\n* `fpx` - FPX\n* `wero` - Wero\n* `p24` - Przelewy24 (P24)\n* `affirm_pay` - Affirm Pay\n* `rakuten_pay` - Rakuten Pay\n",
                            "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\n* `cash` - Cash\n* `check` - Check\n* `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).\n* `bank_transfer` - Bank Transfer\n* `amazon_payments` - Amazon Payments\n* `paypal_express_checkout` - Paypal Express Checkout\n* `direct_debit` - Direct Debit\n* `alipay` - Alipay\n* `unionpay` - Unionpay\n* `apple_pay` - Apple Pay\n* `wechat_pay` - WeChat Pay\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `ideal` - IDEAL\n* `google_pay` - Google Pay\n* `sofort` - Sofort\n* `bancontact` - Bancontact\n* `giropay` - giropay\n* `dotpay` - Dotpay\n* `other` - Payment Methods other than the above types\n* `app_store` - **(Deprecated)** App Store\n* `upi` - upi\n* `netbanking_emandates` - netbanking_emandates\n* `play_store` - **(Deprecated)** Play Store\n* `custom` - Custom\n* `boleto` - boleto\n* `venmo` - Venmo\n* `pay_to` - PayTo\n* `faster_payments` - Faster Payments\n* `sepa_instant_transfer` - Sepa Instant Transfer\n* `automated_bank_transfer` - Automated Bank Transfer\n* `klarna_pay_now` - Klarna Pay Now\n* `online_banking_poland` - Online Banking Poland\n* `payconiq_by_bancontact` - Payconiq by Bancontact\n* `electronic_payment_standard` - Payments made via Electronic Payment Standard.\n* `kbc_payment_button` - Payments made via KBC Payment Button.\n* `pay_by_bank` - Payments made via Pay By Bank.\n* `trustly` - Payments made via Trustly.\n* `stablecoin` - Stablecoin\n* `kakao_pay` - Kakao Pay\n* `naver_pay` - Naver Pay\n* `revolut_pay` - Revolut Pay\n* `cash_app_pay` - Cash App Pay\n* `pix` - Payments made via Pix\n* `twint` - Twint\n* `go_pay` - Go Pay\n* `grab_pay` - Grab Pay\n* `pay_co` - Pay Co\n* `after_pay` - After Pay\n* `swish` - Swish\n* `payme` - PayMe\n* `klarna` - Payments made via Klarna\n* `alipay_hk` - Alipay HK\n* `paypay` - PayPay\n* `gcash` - GCash\n* `south_korean_cards` - Payments made via South Korean Cards\n* `paynow` - Payments made via PayNow\n* `bizum` - Payments made via Bizum\n* `promptpay` - Payments made via PromptPay\n* `dana` - Dana\n* `touch_n_go` - Touch 'n Go\n* `tamara` - Tamara\n* `qpay` - Qpay\n* `ovo` - OVO\n* `momo` - MoMo\n* `mercado_pago` - Mercado Pago\n* `nequi` - Nequi\n* `nupay` - NuPay\n* `picpay` - PicPay\n* `thai_qr` - Thai QR\n* `blik` - BLIK\n* `fpx` - FPX\n* `wero` - Wero\n* `p24` - Przelewy24 (P24)\n* `affirm_pay` - Affirm Pay\n* `rakuten_pay` - Rakuten Pay\n",
                            "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\n",
                        "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\n",
                        "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.\n",
                        "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)\n= `check`\n.\n",
                        "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.\n",
                        "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).\n* `payment` - The transaction represents capture of [amount](transactions#transaction_amount) from the customer's [payment_source](payment_sources).\n* `refund` - The transaction represents a refund of [amount](transactions#transaction_amount) to the customer's [payment_source](payment_sources).\n* `payment_reversal` - Indicates a reversal transaction.\n",
                            "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).\n* `payment` - The transaction represents capture of [amount](transactions#transaction_amount) from the customer's [payment_source](payment_sources).\n* `refund` - The transaction represents a refund of [amount](transactions#transaction_amount) to the customer's [payment_source](payment_sources).\n* `payment_reversal` - Indicates a reversal transaction.\n",
                            "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).\n* `payment` - The transaction represents capture of [amount](transactions#transaction_amount) from the customer's [payment_source](payment_sources).\n* `refund` - The transaction represents a refund of [amount](transactions#transaction_amount) to the customer's [payment_source](payment_sources).\n* `payment_reversal` - Indicates a reversal transaction.\n",
                            "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).\n* `payment` - The transaction represents capture of [amount](transactions#transaction_amount) from the customer's [payment_source](payment_sources).\n* `refund` - The transaction represents a refund of [amount](transactions#transaction_amount) to the customer's [payment_source](payment_sources).\n* `payment_reversal` - Indicates a reversal transaction.\n",
                            "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.\n",
                        "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.\n",
                        "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.\n",
                        "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.\n",
                        "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.\n* `success` - The transaction is successful.\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* `timeout` - Transaction failed because of Gateway not accepting the connection.\n* `needs_attention` - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually\n* `late_failure` - This status indicates that late failure has been recorded for the transaction that has encountered success state in the previous stage.\n",
                            "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.\n* `success` - The transaction is successful.\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* `timeout` - Transaction failed because of Gateway not accepting the connection.\n* `needs_attention` - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually\n* `late_failure` - This status indicates that late failure has been recorded for the transaction that has encountered success state in the previous stage.\n",
                            "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.\n* `success` - The transaction is successful.\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* `timeout` - Transaction failed because of Gateway not accepting the connection.\n* `needs_attention` - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually\n* `late_failure` - This status indicates that late failure has been recorded for the transaction that has encountered success state in the previous stage.\n",
                            "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.\n* `success` - The transaction is successful.\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* `timeout` - Transaction failed because of Gateway not accepting the connection.\n* `needs_attention` - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually\n* `late_failure` - This status indicates that late failure has been recorded for the transaction that has encountered success state in the previous stage.\n",
                            "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`.\nThis 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`\ninput parameter as `updated_at`\nfor a faster response.\n",
                        "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\n"
                    }
                  },
                  "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
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "payment_owner" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "optional, string filter\n\nPayment owner of an invoice.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*payment_owner\\[is\\] = \"payment_customer\"*\n",
                    "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\n",
                    "properties" : {
                      "id" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "The invoice number. Acts as a identifier for invoice and typically generated sequentially.\n",
                        "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.\nNOTE: Not to be used if *consolidated invoicing*\nis enabled.\n",
                        "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.\n",
                        "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\n",
                        "example" : "true",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "format" : "boolean",
                            "enum" : [ "true", "false" ],
                            "example" : null
                          }
                        }
                      },
                      "status" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "Current status of this invoice.\n",
                        "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.\n",
                        "example" : "tax_exclusive",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "description" : "* `tax_exclusive` - All amounts in the document are exclusive of tax.\n* `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.\n* `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.\n* `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.\n* `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.\n",
                        "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.\n",
                        "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.\n",
                        "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`\nfor all `linked_payments[]`\nthat have `txn_status`\nas `success`.\n",
                        "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.\n",
                        "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.\n",
                        "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)\n\n* [amount_paid](/docs/api/invoices/invoice-object#amount_paid)\n* sum of [applied_credits](/docs/api/invoices/invoice-object#applied_credits)`.applied_amount`\n* sum of [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)`.cn_total`\n* sum of [linked_taxes_withheld](/docs/api/invoices/invoice-object#linked_taxes_withheld)`.amount`.\n",
                        "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.\n",
                        "example" : "in_progress",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "description" : "* `in_progress` - Dunning is still in progress.\n* `exhausted` - Maximum number of attempts have been made.\n* `stopped` - Dunning has stopped for this invoice.\n* `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.\n* `exhausted` - Maximum number of attempts have been made.\n* `stopped` - Dunning has stopped for this invoice.\n* `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.\n* `exhausted` - Maximum number of attempts have been made.\n* `stopped` - Dunning has stopped for this invoice.\n* `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.\n* `exhausted` - Maximum number of attempts have been made.\n* `stopped` - Dunning has stopped for this invoice.\n* `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`.\nThis 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`\ninput parameter as `updated_at`\nfor a faster response. [Learn more](/docs/api/v2/pcv-1/exports) about the best practice before performing full export.\n",
                        "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.\n",
                        "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\n"
                    }
                  },
                  "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.\n\n**Note:** In case the export is in Failed or In-process state, then the downloads resource will not be available.\n",
        "operationId" : "retrieve_an_export",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "export-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/export-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "export" : {
                      "$ref" : "#/components/schemas/Export",
                      "description" : "Resource object representing export\n"
                    }
                  },
                  "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:**\nThis report is deprecated. Therefore, the endpoint is also deprecated.\n\nThis API triggers export for the Deferred Revenue Report.\n\n**Note:**\nThis API call is asynchronous.\nYou need to check if this operation has completed by checking if the export status is **completed**\n. 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**\nfunction provided as an instance method in the library.\nYou 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.\n",
        "operationId" : "export_deferred_revenue_reports",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "report_by" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Determines the scope of the report. Returns the report based on the value specified.\n\n* subscription - Subscription\n* invoice - Invoice\n* product - Product (Includes Plan, Addon and Adhoc)\n* customer - Customer\n",
                    "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.\n",
                    "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.\n",
                    "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.\n",
                    "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.\n",
                    "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.\n",
                    "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.\n",
                    "example" : null
                  },
                  "payment_owner" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "optional, string filter\n\nPayment owner of an invoice.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*payment_owner\\[is\\] = \"payment_customer\"*\n",
                    "example" : "payment_customer",
                    "properties" : {
                      "is" : {
                        "type" : "string",
                        "minLength" : 1,
                        "example" : null
                      },
                      "is_not" : {
                        "type" : "string",
                        "minLength" : 1,
                        "example" : null
                      },
                      "starts_with" : {
                        "type" : "string",
                        "minLength" : 1,
                        "example" : null
                      },
                      "in" : {
                        "type" : "string",
                        "pattern" : "^\\[(.*)(,.*)*\\]$",
                        "example" : null
                      },
                      "not_in" : {
                        "type" : "string",
                        "pattern" : "^\\[(.*)(,.*)*\\]$",
                        "example" : null
                      }
                    }
                  },
                  "cancel_reason_code" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "optional, string filter\n\nReason 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** .\nMust be passed if set as mandatory in the app. The codes are case-sensitive.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*cancel_reason_code\\[is_not\\] = \"Not Paid\"*\n",
                    "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\n\nThe ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity.  \n**Note**\n\n[Multiple Business Entities](/docs/api/getting-started) is a feature available only on Product Catalog 2.0.\n\n**Supported operators :**\nis, is_not, starts_with\n\n**Example →**\n*business_entity_id\\[is\\] = \"business_entity_id\"*\n",
                    "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\n",
                    "properties" : {
                      "id" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "The invoice number. Acts as a identifier for invoice and typically generated sequentially.\n",
                        "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\n",
                        "example" : "true",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "format" : "boolean",
                            "enum" : [ "true", "false" ],
                            "example" : null
                          }
                        }
                      },
                      "status" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "Current status of this invoice.\n",
                        "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.\n",
                        "example" : "tax_exclusive",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "description" : "* `tax_exclusive` - All amounts in the document are exclusive of tax.\n* `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.\n* `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.\n* `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.\n* `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.\n",
                        "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.\n",
                        "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.\n",
                        "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`\nfor all `linked_payments[]`\nthat have `txn_status`\nas `success`.\n",
                        "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.\n",
                        "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.\n",
                        "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)\n\n* [amount_paid](/docs/api/invoices/invoice-object#amount_paid)\n* sum of [applied_credits](/docs/api/invoices/invoice-object#applied_credits)`.applied_amount`\n* sum of [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)`.cn_total`\n* sum of [linked_taxes_withheld](/docs/api/invoices/invoice-object#linked_taxes_withheld)`.amount`.\n",
                        "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.\n",
                        "example" : "in_progress",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "description" : "* `in_progress` - Dunning is still in progress.\n* `exhausted` - Maximum number of attempts have been made.\n* `stopped` - Dunning has stopped for this invoice.\n* `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.\n* `exhausted` - Maximum number of attempts have been made.\n* `stopped` - Dunning has stopped for this invoice.\n* `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.\n* `exhausted` - Maximum number of attempts have been made.\n* `stopped` - Dunning has stopped for this invoice.\n* `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.\n* `exhausted` - Maximum number of attempts have been made.\n* `stopped` - Dunning has stopped for this invoice.\n* `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`.\nThis 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`\ninput parameter as `updated_at`\nfor a faster response.\n",
                        "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.\n",
                        "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\n",
                    "properties" : {
                      "id" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "A unique and immutable identifier for the subscription. If not provided, it is autogenerated.\n",
                        "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.\n",
                        "example" : "8gsnbYfsMLds",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "minLength" : 1,
                            "example" : null
                          },
                          "is_not" : {
                            "type" : "string",
                            "minLength" : 1,
                            "example" : null
                          },
                          "starts_with" : {
                            "type" : "string",
                            "minLength" : 1,
                            "example" : null
                          },
                          "in" : {
                            "type" : "string",
                            "pattern" : "^\\[(.*)(,.*)*\\]$",
                            "example" : null
                          },
                          "not_in" : {
                            "type" : "string",
                            "pattern" : "^\\[(.*)(,.*)*\\]$",
                            "example" : null
                          }
                        }
                      },
                      "plan_id" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "Identifier of the plan for this subscription\n",
                        "example" : "basic",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "minLength" : 1,
                            "example" : null
                          },
                          "is_not" : {
                            "type" : "string",
                            "minLength" : 1,
                            "example" : null
                          },
                          "starts_with" : {
                            "type" : "string",
                            "minLength" : 1,
                            "example" : null
                          },
                          "in" : {
                            "type" : "string",
                            "pattern" : "^\\[(.*)(,.*)*\\]$",
                            "example" : null
                          },
                          "not_in" : {
                            "type" : "string",
                            "pattern" : "^\\[(.*)(,.*)*\\]$",
                            "example" : null
                          }
                        }
                      },
                      "status" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "Current state of the subscription\n",
                        "example" : "active",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "description" : "* `future` - The subscription is scheduled to start at a future date.\n* `in_trial` - The subscription is in trial.\n* `active` - The subscription is active and will be charged for automatically based on the items in it.\n* `non_renewing` - The subscription will be canceled at the end of the current term.\n* `paused` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state.\n* `cancelled` - The subscription has been canceled and is no longer in service.\n* `transferred` - The subscription has been transferred to another business entity within the organization.\n",
                            "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.\n* `in_trial` - The subscription is in trial.\n* `active` - The subscription is active and will be charged for automatically based on the items in it.\n* `non_renewing` - The subscription will be canceled at the end of the current term.\n* `paused` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state.\n* `cancelled` - The subscription has been canceled and is no longer in service.\n* `transferred` - The subscription has been transferred to another business entity within the organization.\n",
                            "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.\n* `in_trial` - The subscription is in trial.\n* `active` - The subscription is active and will be charged for automatically based on the items in it.\n* `non_renewing` - The subscription will be canceled at the end of the current term.\n* `paused` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state.\n* `cancelled` - The subscription has been canceled and is no longer in service.\n* `transferred` - The subscription has been transferred to another business entity within the organization.\n",
                            "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.\n* `in_trial` - The subscription is in trial.\n* `active` - The subscription is active and will be charged for automatically based on the items in it.\n* `non_renewing` - The subscription will be canceled at the end of the current term.\n* `paused` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state.\n* `cancelled` - The subscription has been canceled and is no longer in service.\n* `transferred` - The subscription has been transferred to another business entity within the organization.\n",
                            "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.\n",
                        "example" : "not_paid",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "description" : "* `not_paid` - Not Paid\n* `no_card` - No Card\n* `fraud_review_failed` - Fraud Review Failed\n* `non_compliant_eu_customer` - Non Compliant EU Customer\n* `tax_calculation_failed` - Tax Calculation Failed\n* `currency_incompatible_with_gateway` - Currency incompatible with Gateway\n* `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\n* `no_card` - No Card\n* `fraud_review_failed` - Fraud Review Failed\n* `non_compliant_eu_customer` - Non Compliant EU Customer\n* `tax_calculation_failed` - Tax Calculation Failed\n* `currency_incompatible_with_gateway` - Currency incompatible with Gateway\n* `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\n* `no_card` - No Card\n* `fraud_review_failed` - Fraud Review Failed\n* `non_compliant_eu_customer` - Non Compliant EU Customer\n* `tax_calculation_failed` - Tax Calculation Failed\n* `currency_incompatible_with_gateway` - Currency incompatible with Gateway\n* `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\n* `no_card` - No Card\n* `fraud_review_failed` - Fraud Review Failed\n* `non_compliant_eu_customer` - Non Compliant EU Customer\n* `tax_calculation_failed` - Tax Calculation Failed\n* `currency_incompatible_with_gateway` - Currency incompatible with Gateway\n* `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.\n* 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.\n",
                        "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.\n",
                        "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`\nlast changed to\n`active`.\nFor example, this value is updated when an `in_trial`\nor\n`cancelled`\nsubscription activates.\n",
                        "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`\nunless multiple subscription terms were invoiced in advance using the `terms_to_charge`\nparameter.\n",
                        "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.\n",
                        "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`\n, there are subscription changes scheduled on next renewal.\n",
                        "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`.\nThis 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`\ninput parameter as `updated_at`\nfor a faster response.\n",
                        "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.\n",
                        "example" : "cash",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "description" : "* `no_preference` - No Preference\n* `cash` - Cash\n* `check` - Check\n* `bank_transfer` - Bank Transfer\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `boleto` - Boleto\n* `us_automated_bank_transfer` - US Automated Bank Transfer\n* `eu_automated_bank_transfer` - EU Automated Bank Transfer\n* `uk_automated_bank_transfer` - UK Automated Bank Transfer\n* `jp_automated_bank_transfer` - JP Automated Bank Transfer\n* `mx_automated_bank_transfer` - MX Automated Bank Transfer\n* `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\n* `cash` - Cash\n* `check` - Check\n* `bank_transfer` - Bank Transfer\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `boleto` - Boleto\n* `us_automated_bank_transfer` - US Automated Bank Transfer\n* `eu_automated_bank_transfer` - EU Automated Bank Transfer\n* `uk_automated_bank_transfer` - UK Automated Bank Transfer\n* `jp_automated_bank_transfer` - JP Automated Bank Transfer\n* `mx_automated_bank_transfer` - MX Automated Bank Transfer\n* `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\n* `cash` - Cash\n* `check` - Check\n* `bank_transfer` - Bank Transfer\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `boleto` - Boleto\n* `us_automated_bank_transfer` - US Automated Bank Transfer\n* `eu_automated_bank_transfer` - EU Automated Bank Transfer\n* `uk_automated_bank_transfer` - UK Automated Bank Transfer\n* `jp_automated_bank_transfer` - JP Automated Bank Transfer\n* `mx_automated_bank_transfer` - MX Automated Bank Transfer\n* `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\n* `cash` - Cash\n* `check` - Check\n* `bank_transfer` - Bank Transfer\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `boleto` - Boleto\n* `us_automated_bank_transfer` - US Automated Bank Transfer\n* `eu_automated_bank_transfer` - EU Automated Bank Transfer\n* `uk_automated_bank_transfer` - UK Automated Bank Transfer\n* `jp_automated_bank_transfer` - JP Automated Bank Transfer\n* `mx_automated_bank_transfer` - MX Automated Bank Transfer\n* `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`\nto override for this subscription, the [site-level setting](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing)\nfor 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)\n.\n",
                        "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.\n",
                        "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\n",
                    "properties" : {
                      "id" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "Identifier of the customer.\n",
                        "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\n",
                        "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\n",
                        "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.\n",
                        "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.\n",
                        "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\n",
                        "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\n",
                        "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.\n* `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.\n* `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.\n* `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.\n* `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.\n",
                        "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.\n* `exempt` -\n  * 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.\n  * 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.\n* `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.\n",
                            "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.\n* `exempt` -\n  * 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.\n  * 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.\n* `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.\n",
                            "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.\n* `exempt` -\n  * 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.\n  * 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.\n* `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.\n",
                            "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.\n* `exempt` -\n  * 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.\n  * 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.\n* `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.\n",
                            "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.\n",
                        "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`.\nThis 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`\ninput parameter as `updated_at`\nfor a faster response.\n",
                        "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.\n",
                        "example" : "cash",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "description" : "* `no_preference` - No Preference\n* `cash` - Cash\n* `check` - Check\n* `bank_transfer` - Bank Transfer\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `boleto` - Boleto\n* `us_automated_bank_transfer` - US Automated Bank Transfer\n* `eu_automated_bank_transfer` - EU Automated Bank Transfer\n* `uk_automated_bank_transfer` - UK Automated Bank Transfer\n* `jp_automated_bank_transfer` - JP Automated Bank Transfer\n* `mx_automated_bank_transfer` - MX Automated Bank Transfer\n* `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\n* `cash` - Cash\n* `check` - Check\n* `bank_transfer` - Bank Transfer\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `boleto` - Boleto\n* `us_automated_bank_transfer` - US Automated Bank Transfer\n* `eu_automated_bank_transfer` - EU Automated Bank Transfer\n* `uk_automated_bank_transfer` - UK Automated Bank Transfer\n* `jp_automated_bank_transfer` - JP Automated Bank Transfer\n* `mx_automated_bank_transfer` - MX Automated Bank Transfer\n* `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\n* `cash` - Cash\n* `check` - Check\n* `bank_transfer` - Bank Transfer\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `boleto` - Boleto\n* `us_automated_bank_transfer` - US Automated Bank Transfer\n* `eu_automated_bank_transfer` - EU Automated Bank Transfer\n* `uk_automated_bank_transfer` - UK Automated Bank Transfer\n* `jp_automated_bank_transfer` - JP Automated Bank Transfer\n* `mx_automated_bank_transfer` - MX Automated Bank Transfer\n* `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\n* `cash` - Cash\n* `check` - Check\n* `bank_transfer` - Bank Transfer\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `boleto` - Boleto\n* `us_automated_bank_transfer` - US Automated Bank Transfer\n* `eu_automated_bank_transfer` - EU Automated Bank Transfer\n* `uk_automated_bank_transfer` - UK Automated Bank Transfer\n* `jp_automated_bank_transfer` - JP Automated Bank Transfer\n* `mx_automated_bank_transfer` - MX Automated Bank Transfer\n* `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)\nfor 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)\nwhich takes precedence.\n",
                        "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.\n",
                        "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\n",
                    "properties" : {
                      "parent_id" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "Immediate parent with whom we will link our new customer(child)\n",
                        "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\n",
                        "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\n",
                        "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\n"
                    }
                  },
                  "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:**\nThis report is deprecated. Therefore, the endpoint is also deprecated.\n\nThis API triggers export for the revenue recognition report.\n\n**Note:**\nThis API call is asynchronous.\nYou need to check if this operation has completed by checking if the export status is **completed**\n. 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**\nfunction provided as an instance method in the library.\nYou 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.\n",
        "operationId" : "export_revenue_recognition_reports",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "report_by" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Determines the scope of the report. Returns the report based on the value specified.\n\n* subscription - Subscription\n* invoice - Invoice\n* product - Product (Includes Plan, Addon and Adhoc)\n* customer - Customer\n",
                    "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)\nformat. Generates the report based on the value specified. If no currency_code value is specified, then consolidated report based on base currency is returned.\n",
                    "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.\n",
                    "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.\n",
                    "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.\n",
                    "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.\n",
                    "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.\n",
                    "example" : null
                  },
                  "payment_owner" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "optional, string filter\n\nPayment owner of an invoice.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*payment_owner\\[is_not\\] = \"payment_customer\"*\n",
                    "example" : "payment_customer",
                    "properties" : {
                      "is" : {
                        "type" : "string",
                        "minLength" : 1,
                        "example" : null
                      },
                      "is_not" : {
                        "type" : "string",
                        "minLength" : 1,
                        "example" : null
                      },
                      "starts_with" : {
                        "type" : "string",
                        "minLength" : 1,
                        "example" : null
                      },
                      "in" : {
                        "type" : "string",
                        "pattern" : "^\\[(.*)(,.*)*\\]$",
                        "example" : null
                      },
                      "not_in" : {
                        "type" : "string",
                        "pattern" : "^\\[(.*)(,.*)*\\]$",
                        "example" : null
                      }
                    }
                  },
                  "cancel_reason_code" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "optional, string filter\n\nReason 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** .\nMust be passed if set as mandatory in the app. The codes are case-sensitive.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*cancel_reason_code\\[is_not\\] = \"Not Paid\"*\n",
                    "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\n\nThe ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity.  \n**Note**\n\n[Multiple Business Entities](/docs/api/getting-started) is a feature available only on Product Catalog 2.0.\n\n**Supported operators :**\nis, is_not, starts_with\n\n**Example →**\n*business_entity_id\\[is\\] = \"business_entity_id\"*\n",
                    "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\n",
                    "properties" : {
                      "id" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "The invoice number. Acts as a identifier for invoice and typically generated sequentially.\n",
                        "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\n",
                        "example" : "true",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "format" : "boolean",
                            "enum" : [ "true", "false" ],
                            "example" : null
                          }
                        }
                      },
                      "status" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "Current status of this invoice.\n",
                        "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.\n",
                        "example" : "tax_exclusive",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "description" : "* `tax_exclusive` - All amounts in the document are exclusive of tax.\n* `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.\n* `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.\n* `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.\n* `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.\n",
                        "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.\n",
                        "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.\n",
                        "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`\nfor all `linked_payments[]`\nthat have `txn_status`\nas `success`.\n",
                        "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.\n",
                        "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.\n",
                        "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)\n\n* [amount_paid](/docs/api/invoices/invoice-object#amount_paid)\n* sum of [applied_credits](/docs/api/invoices/invoice-object#applied_credits)`.applied_amount`\n* sum of [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)`.cn_total`\n* sum of [linked_taxes_withheld](/docs/api/invoices/invoice-object#linked_taxes_withheld)`.amount`.\n",
                        "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.\n",
                        "example" : "in_progress",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "description" : "* `in_progress` - Dunning is still in progress.\n* `exhausted` - Maximum number of attempts have been made.\n* `stopped` - Dunning has stopped for this invoice.\n* `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.\n* `exhausted` - Maximum number of attempts have been made.\n* `stopped` - Dunning has stopped for this invoice.\n* `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.\n* `exhausted` - Maximum number of attempts have been made.\n* `stopped` - Dunning has stopped for this invoice.\n* `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.\n* `exhausted` - Maximum number of attempts have been made.\n* `stopped` - Dunning has stopped for this invoice.\n* `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`.\nThis 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`\ninput parameter as `updated_at`\nfor a faster response.\n",
                        "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.\n",
                        "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\n",
                    "properties" : {
                      "id" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "A unique and immutable identifier for the subscription. If not provided, it is autogenerated.\n",
                        "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.\n",
                        "example" : "8gsnbYfsMLds",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "minLength" : 1,
                            "example" : null
                          },
                          "is_not" : {
                            "type" : "string",
                            "minLength" : 1,
                            "example" : null
                          },
                          "starts_with" : {
                            "type" : "string",
                            "minLength" : 1,
                            "example" : null
                          },
                          "in" : {
                            "type" : "string",
                            "pattern" : "^\\[(.*)(,.*)*\\]$",
                            "example" : null
                          },
                          "not_in" : {
                            "type" : "string",
                            "pattern" : "^\\[(.*)(,.*)*\\]$",
                            "example" : null
                          }
                        }
                      },
                      "plan_id" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "Identifier of the plan for this subscription\n",
                        "example" : "basic",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "minLength" : 1,
                            "example" : null
                          },
                          "is_not" : {
                            "type" : "string",
                            "minLength" : 1,
                            "example" : null
                          },
                          "starts_with" : {
                            "type" : "string",
                            "minLength" : 1,
                            "example" : null
                          },
                          "in" : {
                            "type" : "string",
                            "pattern" : "^\\[(.*)(,.*)*\\]$",
                            "example" : null
                          },
                          "not_in" : {
                            "type" : "string",
                            "pattern" : "^\\[(.*)(,.*)*\\]$",
                            "example" : null
                          }
                        }
                      },
                      "status" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "Current state of the subscription\n",
                        "example" : "active",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "description" : "* `future` - The subscription is scheduled to start at a future date.\n* `in_trial` - The subscription is in trial.\n* `active` - The subscription is active and will be charged for automatically based on the items in it.\n* `non_renewing` - The subscription will be canceled at the end of the current term.\n* `paused` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state.\n* `cancelled` - The subscription has been canceled and is no longer in service.\n* `transferred` - The subscription has been transferred to another business entity within the organization.\n",
                            "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.\n* `in_trial` - The subscription is in trial.\n* `active` - The subscription is active and will be charged for automatically based on the items in it.\n* `non_renewing` - The subscription will be canceled at the end of the current term.\n* `paused` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state.\n* `cancelled` - The subscription has been canceled and is no longer in service.\n* `transferred` - The subscription has been transferred to another business entity within the organization.\n",
                            "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.\n* `in_trial` - The subscription is in trial.\n* `active` - The subscription is active and will be charged for automatically based on the items in it.\n* `non_renewing` - The subscription will be canceled at the end of the current term.\n* `paused` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state.\n* `cancelled` - The subscription has been canceled and is no longer in service.\n* `transferred` - The subscription has been transferred to another business entity within the organization.\n",
                            "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.\n* `in_trial` - The subscription is in trial.\n* `active` - The subscription is active and will be charged for automatically based on the items in it.\n* `non_renewing` - The subscription will be canceled at the end of the current term.\n* `paused` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state.\n* `cancelled` - The subscription has been canceled and is no longer in service.\n* `transferred` - The subscription has been transferred to another business entity within the organization.\n",
                            "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.\n",
                        "example" : "not_paid",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "description" : "* `not_paid` - Not Paid\n* `no_card` - No Card\n* `fraud_review_failed` - Fraud Review Failed\n* `non_compliant_eu_customer` - Non Compliant EU Customer\n* `tax_calculation_failed` - Tax Calculation Failed\n* `currency_incompatible_with_gateway` - Currency incompatible with Gateway\n* `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\n* `no_card` - No Card\n* `fraud_review_failed` - Fraud Review Failed\n* `non_compliant_eu_customer` - Non Compliant EU Customer\n* `tax_calculation_failed` - Tax Calculation Failed\n* `currency_incompatible_with_gateway` - Currency incompatible with Gateway\n* `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\n* `no_card` - No Card\n* `fraud_review_failed` - Fraud Review Failed\n* `non_compliant_eu_customer` - Non Compliant EU Customer\n* `tax_calculation_failed` - Tax Calculation Failed\n* `currency_incompatible_with_gateway` - Currency incompatible with Gateway\n* `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\n* `no_card` - No Card\n* `fraud_review_failed` - Fraud Review Failed\n* `non_compliant_eu_customer` - Non Compliant EU Customer\n* `tax_calculation_failed` - Tax Calculation Failed\n* `currency_incompatible_with_gateway` - Currency incompatible with Gateway\n* `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.\n* 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.\n",
                        "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.\n",
                        "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`\nlast changed to\n`active`.\nFor example, this value is updated when an `in_trial`\nor\n`cancelled`\nsubscription activates.\n",
                        "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`\nunless multiple subscription terms were invoiced in advance using the `terms_to_charge`\nparameter.\n",
                        "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.\n",
                        "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`\n, there are subscription changes scheduled on next renewal.\n",
                        "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`.\nThis 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`\ninput parameter as `updated_at`\nfor a faster response.\n",
                        "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.\n",
                        "example" : "cash",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "description" : "* `no_preference` - No Preference\n* `cash` - Cash\n* `check` - Check\n* `bank_transfer` - Bank Transfer\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `boleto` - Boleto\n* `us_automated_bank_transfer` - US Automated Bank Transfer\n* `eu_automated_bank_transfer` - EU Automated Bank Transfer\n* `uk_automated_bank_transfer` - UK Automated Bank Transfer\n* `jp_automated_bank_transfer` - JP Automated Bank Transfer\n* `mx_automated_bank_transfer` - MX Automated Bank Transfer\n* `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\n* `cash` - Cash\n* `check` - Check\n* `bank_transfer` - Bank Transfer\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `boleto` - Boleto\n* `us_automated_bank_transfer` - US Automated Bank Transfer\n* `eu_automated_bank_transfer` - EU Automated Bank Transfer\n* `uk_automated_bank_transfer` - UK Automated Bank Transfer\n* `jp_automated_bank_transfer` - JP Automated Bank Transfer\n* `mx_automated_bank_transfer` - MX Automated Bank Transfer\n* `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\n* `cash` - Cash\n* `check` - Check\n* `bank_transfer` - Bank Transfer\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `boleto` - Boleto\n* `us_automated_bank_transfer` - US Automated Bank Transfer\n* `eu_automated_bank_transfer` - EU Automated Bank Transfer\n* `uk_automated_bank_transfer` - UK Automated Bank Transfer\n* `jp_automated_bank_transfer` - JP Automated Bank Transfer\n* `mx_automated_bank_transfer` - MX Automated Bank Transfer\n* `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\n* `cash` - Cash\n* `check` - Check\n* `bank_transfer` - Bank Transfer\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `boleto` - Boleto\n* `us_automated_bank_transfer` - US Automated Bank Transfer\n* `eu_automated_bank_transfer` - EU Automated Bank Transfer\n* `uk_automated_bank_transfer` - UK Automated Bank Transfer\n* `jp_automated_bank_transfer` - JP Automated Bank Transfer\n* `mx_automated_bank_transfer` - MX Automated Bank Transfer\n* `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`\nto override for this subscription, the [site-level setting](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing)\nfor 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)\n.\n",
                        "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.\n",
                        "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\n",
                    "properties" : {
                      "id" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "Identifier of the customer.\n",
                        "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\n",
                        "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\n",
                        "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.\n",
                        "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.\n",
                        "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\n",
                        "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\n",
                        "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.\n* `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.\n* `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.\n* `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.\n* `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.\n",
                        "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.\n* `exempt` -\n  * 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.\n  * 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.\n* `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.\n",
                            "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.\n* `exempt` -\n  * 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.\n  * 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.\n* `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.\n",
                            "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.\n* `exempt` -\n  * 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.\n  * 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.\n* `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.\n",
                            "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.\n* `exempt` -\n  * 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.\n  * 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.\n* `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.\n",
                            "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.\n",
                        "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`.\nThis 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`\ninput parameter as `updated_at`\nfor a faster response.\n",
                        "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.\n",
                        "example" : "cash",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "description" : "* `no_preference` - No Preference\n* `cash` - Cash\n* `check` - Check\n* `bank_transfer` - Bank Transfer\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `boleto` - Boleto\n* `us_automated_bank_transfer` - US Automated Bank Transfer\n* `eu_automated_bank_transfer` - EU Automated Bank Transfer\n* `uk_automated_bank_transfer` - UK Automated Bank Transfer\n* `jp_automated_bank_transfer` - JP Automated Bank Transfer\n* `mx_automated_bank_transfer` - MX Automated Bank Transfer\n* `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\n* `cash` - Cash\n* `check` - Check\n* `bank_transfer` - Bank Transfer\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `boleto` - Boleto\n* `us_automated_bank_transfer` - US Automated Bank Transfer\n* `eu_automated_bank_transfer` - EU Automated Bank Transfer\n* `uk_automated_bank_transfer` - UK Automated Bank Transfer\n* `jp_automated_bank_transfer` - JP Automated Bank Transfer\n* `mx_automated_bank_transfer` - MX Automated Bank Transfer\n* `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\n* `cash` - Cash\n* `check` - Check\n* `bank_transfer` - Bank Transfer\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `boleto` - Boleto\n* `us_automated_bank_transfer` - US Automated Bank Transfer\n* `eu_automated_bank_transfer` - EU Automated Bank Transfer\n* `uk_automated_bank_transfer` - UK Automated Bank Transfer\n* `jp_automated_bank_transfer` - JP Automated Bank Transfer\n* `mx_automated_bank_transfer` - MX Automated Bank Transfer\n* `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\n* `cash` - Cash\n* `check` - Check\n* `bank_transfer` - Bank Transfer\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `boleto` - Boleto\n* `us_automated_bank_transfer` - US Automated Bank Transfer\n* `eu_automated_bank_transfer` - EU Automated Bank Transfer\n* `uk_automated_bank_transfer` - UK Automated Bank Transfer\n* `jp_automated_bank_transfer` - JP Automated Bank Transfer\n* `mx_automated_bank_transfer` - MX Automated Bank Transfer\n* `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)\nfor 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)\nwhich takes precedence.\n",
                        "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.\n",
                        "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\n",
                    "properties" : {
                      "parent_id" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "Immediate parent with whom we will link our new customer(child)\n",
                        "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\n",
                        "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\n",
                        "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\n"
                    }
                  },
                  "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.\n",
        "operationId" : "export_credit_notes",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "credit_note" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for credit_note\n",
                    "properties" : {
                      "id" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "Credit-note id.\n",
                        "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.\n",
                        "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.\nNOTE: Not to be used if *consolidated invoicing*\nfeature is enabled.\n",
                        "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\n",
                        "example" : "INVOICE_876",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "minLength" : 1,
                            "example" : null
                          },
                          "is_not" : {
                            "type" : "string",
                            "minLength" : 1,
                            "example" : null
                          },
                          "starts_with" : {
                            "type" : "string",
                            "minLength" : 1,
                            "example" : null
                          },
                          "is_present" : {
                            "type" : "string",
                            "format" : "boolean",
                            "enum" : [ "true", "false" ],
                            "example" : null
                          },
                          "in" : {
                            "type" : "string",
                            "pattern" : "^\\[(.*)(,.*)*\\]$",
                            "example" : null
                          },
                          "not_in" : {
                            "type" : "string",
                            "pattern" : "^\\[(.*)(,.*)*\\]$",
                            "example" : null
                          }
                        }
                      },
                      "type" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "The credit note type. [Learn more](/docs/api/v2/pcv-1/credit_notes/credit-note-object)\nabout credit note types.\n",
                        "example" : "adjustment",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "description" : "* `adjustment` - Adjustment Credit Note\n* `refundable` - Refundable Credit Note\n* `store` - Store Credit Note",
                            "enum" : [ "adjustment", "refundable", "store" ],
                            "example" : null
                          },
                          "is_not" : {
                            "type" : "string",
                            "description" : "* `adjustment` - Adjustment Credit Note\n* `refundable` - Refundable Credit Note\n* `store` - Store Credit Note",
                            "enum" : [ "adjustment", "refundable", "store" ],
                            "example" : null
                          },
                          "in" : {
                            "type" : "string",
                            "description" : "* `adjustment` - Adjustment Credit Note\n* `refundable` - Refundable Credit Note\n* `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\n* `refundable` - Refundable Credit Note\n* `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)\nparameter instead\\]\n",
                        "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.\n* `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\n* `subscription_cancellation` - This reason will be set automatically for Credit Notes created during cancel subscription operation\n* `subscription_pause` - This reason will be automatically set to credit notes created during pause/resume subscription operation.\n* `chargeback` - Can be set when you are recording your customer Chargebacks\n* `product_unsatisfactory` - Product Unsatisfactory\n* `service_unsatisfactory` - Service Unsatisfactory\n* `order_change` - Order Change\n* `order_cancellation` - Order Cancellation\n* `waiver` - Waiver\n* `other` - Can be set when none of the above reason codes are applicable\n* `fraudulent` - FRAUDULENT\n",
                            "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.\n* `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\n* `subscription_cancellation` - This reason will be set automatically for Credit Notes created during cancel subscription operation\n* `subscription_pause` - This reason will be automatically set to credit notes created during pause/resume subscription operation.\n* `chargeback` - Can be set when you are recording your customer Chargebacks\n* `product_unsatisfactory` - Product Unsatisfactory\n* `service_unsatisfactory` - Service Unsatisfactory\n* `order_change` - Order Change\n* `order_cancellation` - Order Cancellation\n* `waiver` - Waiver\n* `other` - Can be set when none of the above reason codes are applicable\n* `fraudulent` - FRAUDULENT\n",
                            "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.\n* `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\n* `subscription_cancellation` - This reason will be set automatically for Credit Notes created during cancel subscription operation\n* `subscription_pause` - This reason will be automatically set to credit notes created during pause/resume subscription operation.\n* `chargeback` - Can be set when you are recording your customer Chargebacks\n* `product_unsatisfactory` - Product Unsatisfactory\n* `service_unsatisfactory` - Service Unsatisfactory\n* `order_change` - Order Change\n* `order_cancellation` - Order Cancellation\n* `waiver` - Waiver\n* `other` - Can be set when none of the above reason codes are applicable\n* `fraudulent` - FRAUDULENT\n",
                            "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.\n* `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\n* `subscription_cancellation` - This reason will be set automatically for Credit Notes created during cancel subscription operation\n* `subscription_pause` - This reason will be automatically set to credit notes created during pause/resume subscription operation.\n* `chargeback` - Can be set when you are recording your customer Chargebacks\n* `product_unsatisfactory` - Product Unsatisfactory\n* `service_unsatisfactory` - Service Unsatisfactory\n* `order_change` - Order Change\n* `order_cancellation` - Order Cancellation\n* `waiver` - Waiver\n* `other` - Can be set when none of the above reason codes are applicable\n* `fraudulent` - FRAUDULENT\n",
                            "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**.\nMust be passed if set as mandatory in the app. The codes are case-sensitive\n",
                        "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.\n",
                        "example" : "adjusted",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "description" : "* `adjusted` - When the Credit Note has been adjusted against an invoice.\n* `refunded` - When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded).\n* `refund_due` - When the credits are yet to be used, or have been partially used.\n* `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.\n* `refunded` - When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded).\n* `refund_due` - When the credits are yet to be used, or have been partially used.\n* `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.\n* `refunded` - When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded).\n* `refund_due` - When the credits are yet to be used, or have been partially used.\n* `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.\n* `refunded` - When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded).\n* `refund_due` - When the credits are yet to be used, or have been partially used.\n* `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.\n",
                        "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.\n",
                        "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.\n",
                        "example" : "tax_exclusive",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "description" : "* `tax_exclusive` - All amounts in the document are exclusive of tax.\n* `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.\n* `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.\n* `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.\n* `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.\n",
                        "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.\n",
                        "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.\n",
                        "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.\n",
                        "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.\n",
                        "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.\n",
                        "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\n"
                    }
                  },
                  "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.\n",
        "operationId" : "export_coupons",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "currency_code" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "optional, string filter\n\nThe currency code ([ISO 4217 format](https://www.chargebee.com/docs/supported-currencies.html)\n) of the coupon. Applicable for *fixed_amount*\ncoupons alone.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*currency_code\\[is\\] = \"USD\"*\n",
                    "example" : "USD",
                    "properties" : {
                      "is" : {
                        "type" : "string",
                        "minLength" : 1,
                        "example" : null
                      },
                      "is_not" : {
                        "type" : "string",
                        "minLength" : 1,
                        "example" : null
                      },
                      "starts_with" : {
                        "type" : "string",
                        "minLength" : 1,
                        "example" : null
                      },
                      "in" : {
                        "type" : "string",
                        "pattern" : "^\\[(.*)(,.*)*\\]$",
                        "example" : null
                      },
                      "not_in" : {
                        "type" : "string",
                        "pattern" : "^\\[(.*)(,.*)*\\]$",
                        "example" : null
                      }
                    }
                  },
                  "applicable_item_price_ids" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "List of itemPrice ids for which these coupons are applicable.\n",
                    "example" : "day-pass-USD",
                    "properties" : {
                      "is" : {
                        "type" : "string",
                        "minLength" : 1,
                        "example" : null
                      },
                      "in" : {
                        "type" : "string",
                        "pattern" : "^\\[(.*)(,.*)*\\]$",
                        "example" : null
                      }
                    }
                  },
                  "coupon" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for coupon\n",
                    "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\n",
                        "example" : "fixed_amount",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "description" : "* `fixed_amount` - The specified amount will be deducted.\n* `percentage` - The specified percentage will be deducted.\n* `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.\n* `percentage` - The specified percentage will be deducted.\n* `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.\n* `percentage` - The specified percentage will be deducted.\n* `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.\n* `percentage` - The specified percentage will be deducted.\n* `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.\n",
                        "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.\n* `forever` - The coupon is attached to the subscription and applied on the invoices until explicitly removed.\n* `limited_period` - The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by `period` and `period_unit`.\n",
                            "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.\n* `forever` - The coupon is attached to the subscription and applied on the invoices until explicitly removed.\n* `limited_period` - The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by `period` and `period_unit`.\n",
                            "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.\n* `forever` - The coupon is attached to the subscription and applied on the invoices until explicitly removed.\n* `limited_period` - The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by `period` and `period_unit`.\n",
                            "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.\n* `forever` - The coupon is attached to the subscription and applied on the invoices until explicitly removed.\n* `limited_period` - The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by `period` and `period_unit`.\n",
                            "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.\n",
                        "example" : "active",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "description" : "* `active` - Can be applied to a subscription.\n* `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.\n* `archived` - Cannot be applied to a subscription. Existing associations remain unaffected.\n* `deleted` - Indicates the coupon has been deleted.\n",
                            "enum" : [ "active", "expired", "archived", "deleted" ],
                            "example" : null
                          },
                          "is_not" : {
                            "type" : "string",
                            "description" : "* `active` - Can be applied to a subscription.\n* `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.\n* `archived` - Cannot be applied to a subscription. Existing associations remain unaffected.\n* `deleted` - Indicates the coupon has been deleted.\n",
                            "enum" : [ "active", "expired", "archived", "deleted" ],
                            "example" : null
                          },
                          "in" : {
                            "type" : "string",
                            "description" : "* `active` - Can be applied to a subscription.\n* `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.\n* `archived` - Cannot be applied to a subscription. Existing associations remain unaffected.\n* `deleted` - Indicates the coupon has been deleted.\n",
                            "enum" : [ "active", "expired", "archived", "deleted" ],
                            "pattern" : "^\\[(active|expired|archived|deleted)(,(active|expired|archived|deleted))*\\]$",
                            "example" : null
                          },
                          "not_in" : {
                            "type" : "string",
                            "description" : "* `active` - Can be applied to a subscription.\n* `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.\n* `archived` - Cannot be applied to a subscription. Existing associations remain unaffected.\n* `deleted` - Indicates the coupon has been deleted.\n",
                            "enum" : [ "active", "expired", "archived", "deleted" ],
                            "pattern" : "^\\[(active|expired|archived|deleted)(,(active|expired|archived|deleted))*\\]$",
                            "example" : null
                          }
                        }
                      },
                      "apply_on" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "The amount on the invoice to which the coupon is applied.\n",
                        "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.\n",
                        "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.\n",
                        "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\n"
                    }
                  },
                  "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.\n",
        "operationId" : "export_orders",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "total" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "optional, in cents filter\n\nTotal amount charged for the order.\n**Supported operators :**\nis, is_not, lt, lte, gt, gte, between\n\n**Example →**\n*total\\[gt\\] = \"1394532759\"*\n",
                    "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\n",
                    "properties" : {
                      "id" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "Uniquely identifies the order. It is the api identifier for the order\n",
                        "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.\n",
                        "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\n",
                        "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.\n",
                        "example" : "paid",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "description" : "* `new` - Order has been created. Applicable only if you are using Chargebee's legacy order management system.\n* `processing` - Order is being processed. Applicable only if you are using Chargebee's legacy order management system\n* `complete` - Order has been processed successfully. Applicable only if you are using Chargebee's legacy order management system\n* `cancelled` - Order has been cancelled. Applicable only if you are using Chargebee's legacy order management system\n* `voided` - Order has been voided. Applicable only if you are using Chargebee's legacy order management system\n* `queued` - Order is yet to be processed by any system, these are scheduled orders created by Chargebee\n* `awaiting_shipment` - The order has been picked up by an integration system, and synced to a shipping management platform\n* `on_hold` - The order is paused from being processed.\n* `delivered` - The order has been delivered to the customer.\n* `shipped` - The order has moved from order management system to a shipping system.\n* `partially_delivered` - The order has been partially delivered to the customer.\n* `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.\n* `processing` - Order is being processed. Applicable only if you are using Chargebee's legacy order management system\n* `complete` - Order has been processed successfully. Applicable only if you are using Chargebee's legacy order management system\n* `cancelled` - Order has been cancelled. Applicable only if you are using Chargebee's legacy order management system\n* `voided` - Order has been voided. Applicable only if you are using Chargebee's legacy order management system\n* `queued` - Order is yet to be processed by any system, these are scheduled orders created by Chargebee\n* `awaiting_shipment` - The order has been picked up by an integration system, and synced to a shipping management platform\n* `on_hold` - The order is paused from being processed.\n* `delivered` - The order has been delivered to the customer.\n* `shipped` - The order has moved from order management system to a shipping system.\n* `partially_delivered` - The order has been partially delivered to the customer.\n* `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.\n* `processing` - Order is being processed. Applicable only if you are using Chargebee's legacy order management system\n* `complete` - Order has been processed successfully. Applicable only if you are using Chargebee's legacy order management system\n* `cancelled` - Order has been cancelled. Applicable only if you are using Chargebee's legacy order management system\n* `voided` - Order has been voided. Applicable only if you are using Chargebee's legacy order management system\n* `queued` - Order is yet to be processed by any system, these are scheduled orders created by Chargebee\n* `awaiting_shipment` - The order has been picked up by an integration system, and synced to a shipping management platform\n* `on_hold` - The order is paused from being processed.\n* `delivered` - The order has been delivered to the customer.\n* `shipped` - The order has moved from order management system to a shipping system.\n* `partially_delivered` - The order has been partially delivered to the customer.\n* `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.\n* `processing` - Order is being processed. Applicable only if you are using Chargebee's legacy order management system\n* `complete` - Order has been processed successfully. Applicable only if you are using Chargebee's legacy order management system\n* `cancelled` - Order has been cancelled. Applicable only if you are using Chargebee's legacy order management system\n* `voided` - Order has been voided. Applicable only if you are using Chargebee's legacy order management system\n* `queued` - Order is yet to be processed by any system, these are scheduled orders created by Chargebee\n* `awaiting_shipment` - The order has been picked up by an integration system, and synced to a shipping management platform\n* `on_hold` - The order is paused from being processed.\n* `delivered` - The order has been delivered to the customer.\n* `shipped` - The order has moved from order management system to a shipping system.\n* `partially_delivered` - The order has been partially delivered to the customer.\n* `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\n",
                        "example" : "tax_exclusive",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "description" : "* `tax_exclusive` - All amounts in the document are exclusive of tax.\n* `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.\n* `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.\n* `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.\n* `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.\n",
                        "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.\n",
                        "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.\n",
                        "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\n",
                        "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.\n",
                        "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.\n",
                        "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.\n",
                        "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.\n",
                        "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.\n",
                        "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.\n",
                        "example" : "fully_resent",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "description" : "* `fully_resent` - Order is Fully resent\n* `partially_resent` - Order is Partially resent",
                            "enum" : [ "fully_resent", "partially_resent" ],
                            "example" : null
                          },
                          "is_not" : {
                            "type" : "string",
                            "description" : "* `fully_resent` - Order is Fully resent\n* `partially_resent` - Order is Partially resent",
                            "enum" : [ "fully_resent", "partially_resent" ],
                            "example" : null
                          },
                          "in" : {
                            "type" : "string",
                            "description" : "* `fully_resent` - Order is Fully resent\n* `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\n* `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.\n",
                        "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.\n",
                        "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\n"
                    }
                  },
                  "required" : [ "export" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/exports/addons" : {
      "post" : {
        "tags" : [ "exports" ],
        "summary" : "Export addons",
        "description" : "This API triggers export of addon data. The exported zip file contains CSV files with addon-related data.\n",
        "operationId" : "export_addons",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "currency_code" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "optional, string filter\n\nThe currency code (ISO 4217 format) of the addon.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*currency_code\\[is\\] = \"USD\"*\n",
                    "example" : "USD",
                    "properties" : {
                      "is" : {
                        "type" : "string",
                        "minLength" : 1,
                        "example" : null
                      },
                      "is_not" : {
                        "type" : "string",
                        "minLength" : 1,
                        "example" : null
                      },
                      "starts_with" : {
                        "type" : "string",
                        "minLength" : 1,
                        "example" : null
                      },
                      "in" : {
                        "type" : "string",
                        "pattern" : "^\\[(.*)(,.*)*\\]$",
                        "example" : null
                      },
                      "not_in" : {
                        "type" : "string",
                        "pattern" : "^\\[(.*)(,.*)*\\]$",
                        "example" : null
                      }
                    }
                  },
                  "addon" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for addon\n",
                    "properties" : {
                      "id" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "A unique ID for your system to identify the addon.\n",
                        "example" : "support_charge",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "minLength" : 1,
                            "example" : null
                          },
                          "is_not" : {
                            "type" : "string",
                            "minLength" : 1,
                            "example" : null
                          },
                          "starts_with" : {
                            "type" : "string",
                            "minLength" : 1,
                            "example" : null
                          },
                          "in" : {
                            "type" : "string",
                            "pattern" : "^\\[(.*)(,.*)*\\]$",
                            "example" : null
                          },
                          "not_in" : {
                            "type" : "string",
                            "pattern" : "^\\[(.*)(,.*)*\\]$",
                            "example" : null
                          }
                        }
                      },
                      "name" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "The display name used in web interface for identifying the addon.\n",
                        "example" : "Support Charge",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "minLength" : 1,
                            "example" : null
                          },
                          "is_not" : {
                            "type" : "string",
                            "minLength" : 1,
                            "example" : null
                          },
                          "starts_with" : {
                            "type" : "string",
                            "minLength" : 1,
                            "example" : null
                          },
                          "in" : {
                            "type" : "string",
                            "pattern" : "^\\[(.*)(,.*)*\\]$",
                            "example" : null
                          },
                          "not_in" : {
                            "type" : "string",
                            "pattern" : "^\\[(.*)(,.*)*\\]$",
                            "example" : null
                          }
                        }
                      },
                      "charge_type" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "Type of charge\n",
                        "example" : "recurring",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "description" : "* `recurring` - Charges are automatically applied in sync with the billing frequency of subscription.\n* `non_recurring` - Charged immediately and only once every time it is applied.",
                            "enum" : [ "recurring", "non_recurring" ],
                            "example" : null
                          },
                          "is_not" : {
                            "type" : "string",
                            "description" : "* `recurring` - Charges are automatically applied in sync with the billing frequency of subscription.\n* `non_recurring` - Charged immediately and only once every time it is applied.",
                            "enum" : [ "recurring", "non_recurring" ],
                            "example" : null
                          },
                          "in" : {
                            "type" : "string",
                            "description" : "* `recurring` - Charges are automatically applied in sync with the billing frequency of subscription.\n* `non_recurring` - Charged immediately and only once every time it is applied.",
                            "enum" : [ "recurring", "non_recurring" ],
                            "pattern" : "^\\[(recurring|non_recurring)(,(recurring|non_recurring))*\\]$",
                            "example" : null
                          },
                          "not_in" : {
                            "type" : "string",
                            "description" : "* `recurring` - Charges are automatically applied in sync with the billing frequency of subscription.\n* `non_recurring` - Charged immediately and only once every time it is applied.",
                            "enum" : [ "recurring", "non_recurring" ],
                            "pattern" : "^\\[(recurring|non_recurring)(,(recurring|non_recurring))*\\]$",
                            "example" : null
                          }
                        }
                      },
                      "price" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "Addon price is calculated based on the addon type and charge type. [Learn more](https://www.chargebee.com/docs/addons.html#charge-type-and-pricing).\nThe unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                        "example" : "1300",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "format" : "number",
                            "pattern" : "^-?\\d+$",
                            "example" : null
                          },
                          "is_not" : {
                            "type" : "string",
                            "format" : "number",
                            "pattern" : "^-?\\d+$",
                            "example" : null
                          },
                          "lt" : {
                            "type" : "string",
                            "format" : "number",
                            "pattern" : "^-?\\d+$",
                            "example" : null
                          },
                          "lte" : {
                            "type" : "string",
                            "format" : "number",
                            "pattern" : "^-?\\d+$",
                            "example" : null
                          },
                          "gt" : {
                            "type" : "string",
                            "format" : "number",
                            "pattern" : "^-?\\d+$",
                            "example" : null
                          },
                          "gte" : {
                            "type" : "string",
                            "format" : "number",
                            "pattern" : "^-?\\d+$",
                            "example" : null
                          },
                          "between" : {
                            "type" : "string",
                            "pattern" : "^\\[-?\\d+,-?\\d+\\]$",
                            "example" : null
                          }
                        }
                      },
                      "period" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "Applicable only for recurring-addons. Along with 'period_unit' decides the term-price of this addon.\n",
                        "example" : "3",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "format" : "number",
                            "pattern" : "^-?\\d+$",
                            "example" : null
                          },
                          "is_not" : {
                            "type" : "string",
                            "format" : "number",
                            "pattern" : "^-?\\d+$",
                            "example" : null
                          },
                          "lt" : {
                            "type" : "string",
                            "format" : "number",
                            "pattern" : "^-?\\d+$",
                            "example" : null
                          },
                          "lte" : {
                            "type" : "string",
                            "format" : "number",
                            "pattern" : "^-?\\d+$",
                            "example" : null
                          },
                          "gt" : {
                            "type" : "string",
                            "format" : "number",
                            "pattern" : "^-?\\d+$",
                            "example" : null
                          },
                          "gte" : {
                            "type" : "string",
                            "format" : "number",
                            "pattern" : "^-?\\d+$",
                            "example" : null
                          },
                          "between" : {
                            "type" : "string",
                            "pattern" : "^\\[-?\\d+,-?\\d+\\]$",
                            "example" : null
                          }
                        }
                      },
                      "period_unit" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "Applicable only for recurring-addons. Along with 'period' decides the term-price of this addon\n",
                        "example" : "month",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "description" : "* `day` - Charge based on Day(S)\n* `week` - Charge based on week(s)\n* `month` - Charge based on month(s)\n* `year` - Charge based on year(s)\n* `not_applicable` - not applicable for this addon",
                            "enum" : [ "day", "week", "month", "year", "not_applicable" ],
                            "example" : null
                          },
                          "is_not" : {
                            "type" : "string",
                            "description" : "* `day` - Charge based on Day(S)\n* `week` - Charge based on week(s)\n* `month` - Charge based on month(s)\n* `year` - Charge based on year(s)\n* `not_applicable` - not applicable for this addon",
                            "enum" : [ "day", "week", "month", "year", "not_applicable" ],
                            "example" : null
                          },
                          "in" : {
                            "type" : "string",
                            "description" : "* `day` - Charge based on Day(S)\n* `week` - Charge based on week(s)\n* `month` - Charge based on month(s)\n* `year` - Charge based on year(s)\n* `not_applicable` - not applicable for this addon",
                            "enum" : [ "day", "week", "month", "year", "not_applicable" ],
                            "pattern" : "^\\[(day|week|month|year|not_applicable)(,(day|week|month|year|not_applicable))*\\]$",
                            "example" : null
                          },
                          "not_in" : {
                            "type" : "string",
                            "description" : "* `day` - Charge based on Day(S)\n* `week` - Charge based on week(s)\n* `month` - Charge based on month(s)\n* `year` - Charge based on year(s)\n* `not_applicable` - not applicable for this addon",
                            "enum" : [ "day", "week", "month", "year", "not_applicable" ],
                            "pattern" : "^\\[(day|week|month|year|not_applicable)(,(day|week|month|year|not_applicable))*\\]$",
                            "example" : null
                          }
                        }
                      },
                      "status" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "Status of the addon\n",
                        "example" : "active",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "description" : "* `active` - Only active addons can be applied to subscriptions\n* `archived` - No new associations with subscriptions are allowed. Existing associations for recurring addons remain as-is and can be removed if required.\n* `deleted` - Indicates the addon has been deleted.",
                            "enum" : [ "active", "archived", "deleted" ],
                            "example" : null
                          },
                          "is_not" : {
                            "type" : "string",
                            "description" : "* `active` - Only active addons can be applied to subscriptions\n* `archived` - No new associations with subscriptions are allowed. Existing associations for recurring addons remain as-is and can be removed if required.\n* `deleted` - Indicates the addon has been deleted.",
                            "enum" : [ "active", "archived", "deleted" ],
                            "example" : null
                          },
                          "in" : {
                            "type" : "string",
                            "description" : "* `active` - Only active addons can be applied to subscriptions\n* `archived` - No new associations with subscriptions are allowed. Existing associations for recurring addons remain as-is and can be removed if required.\n* `deleted` - Indicates the addon has been deleted.",
                            "enum" : [ "active", "archived", "deleted" ],
                            "pattern" : "^\\[(active|archived|deleted)(,(active|archived|deleted))*\\]$",
                            "example" : null
                          },
                          "not_in" : {
                            "type" : "string",
                            "description" : "* `active` - Only active addons can be applied to subscriptions\n* `archived` - No new associations with subscriptions are allowed. Existing associations for recurring addons remain as-is and can be removed if required.\n* `deleted` - Indicates the addon has been deleted.",
                            "enum" : [ "active", "archived", "deleted" ],
                            "pattern" : "^\\[(active|archived|deleted)(,(active|archived|deleted))*\\]$",
                            "example" : null
                          }
                        }
                      },
                      "updated_at" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "To filter based on updated at. This attribute will be present only if the resource has been updated after 2016-11-09.\n",
                        "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.\n",
                        "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" : {
                "addon" : {
                  "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\n"
                    }
                  },
                  "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.\n",
        "operationId" : "export_subscriptions",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "export_type" : {
                    "type" : "string",
                    "default" : "data",
                    "deprecated" : false,
                    "description" : "Determines the format of the data. Returns the export type based on the selected value.\n\n* data - Provides the full set of data for the subscriptions in multiple `.csv` files.\n* 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).\n",
                    "enum" : [ "data", "import_friendly_data" ],
                    "example" : null
                  },
                  "cancel_reason_code" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "optional, string filter\n\nReason 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** .\nMust be passed if set as mandatory in the app. The codes are case-sensitive.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*cancel_reason_code\\[is\\] = \"Not Paid\"*\n",
                    "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\n",
                    "properties" : {
                      "id" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "A unique and immutable identifier for the subscription. If not provided, it is autogenerated.\n",
                        "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.\n",
                        "example" : "8gsnbYfsMLds",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "minLength" : 1,
                            "example" : null
                          },
                          "is_not" : {
                            "type" : "string",
                            "minLength" : 1,
                            "example" : null
                          },
                          "starts_with" : {
                            "type" : "string",
                            "minLength" : 1,
                            "example" : null
                          },
                          "in" : {
                            "type" : "string",
                            "pattern" : "^\\[(.*)(,.*)*\\]$",
                            "example" : null
                          },
                          "not_in" : {
                            "type" : "string",
                            "pattern" : "^\\[(.*)(,.*)*\\]$",
                            "example" : null
                          }
                        }
                      },
                      "plan_id" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "Identifier of the plan for this subscription\n",
                        "example" : "basic",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "minLength" : 1,
                            "example" : null
                          },
                          "is_not" : {
                            "type" : "string",
                            "minLength" : 1,
                            "example" : null
                          },
                          "starts_with" : {
                            "type" : "string",
                            "minLength" : 1,
                            "example" : null
                          },
                          "in" : {
                            "type" : "string",
                            "pattern" : "^\\[(.*)(,.*)*\\]$",
                            "example" : null
                          },
                          "not_in" : {
                            "type" : "string",
                            "pattern" : "^\\[(.*)(,.*)*\\]$",
                            "example" : null
                          }
                        }
                      },
                      "status" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "Current state of the subscription\n",
                        "example" : "active",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "description" : "* `future` - The subscription is scheduled to start at a future date.\n* `in_trial` - The subscription is in trial.\n* `active` - The subscription is active and will be charged for automatically based on the items in it.\n* `non_renewing` - The subscription will be canceled at the end of the current term.\n* `paused` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state.\n* `cancelled` - The subscription has been canceled and is no longer in service.\n* `transferred` - The subscription has been transferred to another business entity within the organization.\n",
                            "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.\n* `in_trial` - The subscription is in trial.\n* `active` - The subscription is active and will be charged for automatically based on the items in it.\n* `non_renewing` - The subscription will be canceled at the end of the current term.\n* `paused` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state.\n* `cancelled` - The subscription has been canceled and is no longer in service.\n* `transferred` - The subscription has been transferred to another business entity within the organization.\n",
                            "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.\n* `in_trial` - The subscription is in trial.\n* `active` - The subscription is active and will be charged for automatically based on the items in it.\n* `non_renewing` - The subscription will be canceled at the end of the current term.\n* `paused` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state.\n* `cancelled` - The subscription has been canceled and is no longer in service.\n* `transferred` - The subscription has been transferred to another business entity within the organization.\n",
                            "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.\n* `in_trial` - The subscription is in trial.\n* `active` - The subscription is active and will be charged for automatically based on the items in it.\n* `non_renewing` - The subscription will be canceled at the end of the current term.\n* `paused` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state.\n* `cancelled` - The subscription has been canceled and is no longer in service.\n* `transferred` - The subscription has been transferred to another business entity within the organization.\n",
                            "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.\n",
                        "example" : "not_paid",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "description" : "* `not_paid` - Not Paid\n* `no_card` - No Card\n* `fraud_review_failed` - Fraud Review Failed\n* `non_compliant_eu_customer` - Non Compliant EU Customer\n* `tax_calculation_failed` - Tax Calculation Failed\n* `currency_incompatible_with_gateway` - Currency incompatible with Gateway\n* `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\n* `no_card` - No Card\n* `fraud_review_failed` - Fraud Review Failed\n* `non_compliant_eu_customer` - Non Compliant EU Customer\n* `tax_calculation_failed` - Tax Calculation Failed\n* `currency_incompatible_with_gateway` - Currency incompatible with Gateway\n* `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\n* `no_card` - No Card\n* `fraud_review_failed` - Fraud Review Failed\n* `non_compliant_eu_customer` - Non Compliant EU Customer\n* `tax_calculation_failed` - Tax Calculation Failed\n* `currency_incompatible_with_gateway` - Currency incompatible with Gateway\n* `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\n* `no_card` - No Card\n* `fraud_review_failed` - Fraud Review Failed\n* `non_compliant_eu_customer` - Non Compliant EU Customer\n* `tax_calculation_failed` - Tax Calculation Failed\n* `currency_incompatible_with_gateway` - Currency incompatible with Gateway\n* `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.\n* 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.\n",
                        "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.\n",
                        "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`\nlast changed to\n`active`.\nFor example, this value is updated when an `in_trial`\nor\n`cancelled`\nsubscription activates.\n",
                        "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`\nunless multiple subscription terms were invoiced in advance using the `terms_to_charge`\nparameter.\n",
                        "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.\n",
                        "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`\n, there are subscription changes scheduled on next renewal.\n",
                        "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`.\nThis 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`\ninput parameter as `updated_at`\nfor a faster response.\n",
                        "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.\n",
                        "example" : "cash",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "description" : "* `no_preference` - No Preference\n* `cash` - Cash\n* `check` - Check\n* `bank_transfer` - Bank Transfer\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `boleto` - Boleto\n* `us_automated_bank_transfer` - US Automated Bank Transfer\n* `eu_automated_bank_transfer` - EU Automated Bank Transfer\n* `uk_automated_bank_transfer` - UK Automated Bank Transfer\n* `jp_automated_bank_transfer` - JP Automated Bank Transfer\n* `mx_automated_bank_transfer` - MX Automated Bank Transfer\n* `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\n* `cash` - Cash\n* `check` - Check\n* `bank_transfer` - Bank Transfer\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `boleto` - Boleto\n* `us_automated_bank_transfer` - US Automated Bank Transfer\n* `eu_automated_bank_transfer` - EU Automated Bank Transfer\n* `uk_automated_bank_transfer` - UK Automated Bank Transfer\n* `jp_automated_bank_transfer` - JP Automated Bank Transfer\n* `mx_automated_bank_transfer` - MX Automated Bank Transfer\n* `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\n* `cash` - Cash\n* `check` - Check\n* `bank_transfer` - Bank Transfer\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `boleto` - Boleto\n* `us_automated_bank_transfer` - US Automated Bank Transfer\n* `eu_automated_bank_transfer` - EU Automated Bank Transfer\n* `uk_automated_bank_transfer` - UK Automated Bank Transfer\n* `jp_automated_bank_transfer` - JP Automated Bank Transfer\n* `mx_automated_bank_transfer` - MX Automated Bank Transfer\n* `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\n* `cash` - Cash\n* `check` - Check\n* `bank_transfer` - Bank Transfer\n* `ach_credit` - ACH Credit\n* `sepa_credit` - SEPA Credit\n* `boleto` - Boleto\n* `us_automated_bank_transfer` - US Automated Bank Transfer\n* `eu_automated_bank_transfer` - EU Automated Bank Transfer\n* `uk_automated_bank_transfer` - UK Automated Bank Transfer\n* `jp_automated_bank_transfer` - JP Automated Bank Transfer\n* `mx_automated_bank_transfer` - MX Automated Bank Transfer\n* `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`\nto override for this subscription, the [site-level setting](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing)\nfor 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)\n.\n",
                        "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.\n",
                        "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\n"
                    }
                  },
                  "required" : [ "export" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/exports/plans" : {
      "post" : {
        "tags" : [ "exports" ],
        "summary" : "Export plans",
        "description" : "This API triggers export of plan data. The exported zip file contains CSV files with plan-related data.\n",
        "operationId" : "export_plans",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "currency_code" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "optional, string filter\n\nThe currency code (ISO 4217 format) of the plan.\n**Supported operators :**\nis, is_not, starts_with, in, not_in\n\n**Example →**\n*currency_code\\[is\\] = \"USD\"*\n",
                    "example" : "USD",
                    "properties" : {
                      "is" : {
                        "type" : "string",
                        "minLength" : 1,
                        "example" : null
                      },
                      "is_not" : {
                        "type" : "string",
                        "minLength" : 1,
                        "example" : null
                      },
                      "starts_with" : {
                        "type" : "string",
                        "minLength" : 1,
                        "example" : null
                      },
                      "in" : {
                        "type" : "string",
                        "pattern" : "^\\[(.*)(,.*)*\\]$",
                        "example" : null
                      },
                      "not_in" : {
                        "type" : "string",
                        "pattern" : "^\\[(.*)(,.*)*\\]$",
                        "example" : null
                      }
                    }
                  },
                  "plan" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for plan\n",
                    "properties" : {
                      "id" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "A unique ID for your system to identify the plan.\n",
                        "example" : "Enterprise",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "minLength" : 1,
                            "example" : null
                          },
                          "is_not" : {
                            "type" : "string",
                            "minLength" : 1,
                            "example" : null
                          },
                          "starts_with" : {
                            "type" : "string",
                            "minLength" : 1,
                            "example" : null
                          },
                          "in" : {
                            "type" : "string",
                            "pattern" : "^\\[(.*)(,.*)*\\]$",
                            "example" : null
                          },
                          "not_in" : {
                            "type" : "string",
                            "pattern" : "^\\[(.*)(,.*)*\\]$",
                            "example" : null
                          }
                        }
                      },
                      "name" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "The display name used in web interface for identifying the plan.\n",
                        "example" : "plan_enterprise",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "minLength" : 1,
                            "example" : null
                          },
                          "is_not" : {
                            "type" : "string",
                            "minLength" : 1,
                            "example" : null
                          },
                          "starts_with" : {
                            "type" : "string",
                            "minLength" : 1,
                            "example" : null
                          },
                          "in" : {
                            "type" : "string",
                            "pattern" : "^\\[(.*)(,.*)*\\]$",
                            "example" : null
                          },
                          "not_in" : {
                            "type" : "string",
                            "pattern" : "^\\[(.*)(,.*)*\\]$",
                            "example" : null
                          }
                        }
                      },
                      "price" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "The price of the plan. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                        "example" : "1200",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "format" : "number",
                            "pattern" : "^-?\\d+$",
                            "example" : null
                          },
                          "is_not" : {
                            "type" : "string",
                            "format" : "number",
                            "pattern" : "^-?\\d+$",
                            "example" : null
                          },
                          "lt" : {
                            "type" : "string",
                            "format" : "number",
                            "pattern" : "^-?\\d+$",
                            "example" : null
                          },
                          "lte" : {
                            "type" : "string",
                            "format" : "number",
                            "pattern" : "^-?\\d+$",
                            "example" : null
                          },
                          "gt" : {
                            "type" : "string",
                            "format" : "number",
                            "pattern" : "^-?\\d+$",
                            "example" : null
                          },
                          "gte" : {
                            "type" : "string",
                            "format" : "number",
                            "pattern" : "^-?\\d+$",
                            "example" : null
                          },
                          "between" : {
                            "type" : "string",
                            "pattern" : "^\\[-?\\d+,-?\\d+\\]$",
                            "example" : null
                          }
                        }
                      },
                      "period" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "Defines billing frequency. Example: to bill customer every 3 months, provide \"3\" here.\n",
                        "example" : "3",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "format" : "number",
                            "pattern" : "^-?\\d+$",
                            "example" : null
                          },
                          "is_not" : {
                            "type" : "string",
                            "format" : "number",
                            "pattern" : "^-?\\d+$",
                            "example" : null
                          },
                          "lt" : {
                            "type" : "string",
                            "format" : "number",
                            "pattern" : "^-?\\d+$",
                            "example" : null
                          },
                          "lte" : {
                            "type" : "string",
                            "format" : "number",
                            "pattern" : "^-?\\d+$",
                            "example" : null
                          },
                          "gt" : {
                            "type" : "string",
                            "format" : "number",
                            "pattern" : "^-?\\d+$",
                            "example" : null
                          },
                          "gte" : {
                            "type" : "string",
                            "format" : "number",
                            "pattern" : "^-?\\d+$",
                            "example" : null
                          },
                          "between" : {
                            "type" : "string",
                            "pattern" : "^\\[-?\\d+,-?\\d+\\]$",
                            "example" : null
                          }
                        }
                      },
                      "period_unit" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "Defines billing frequency in association with billing period.\n",
                        "example" : "month",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "description" : "* `day` - Charge based on day(s)\n* `week` - Charge based on week(s)\n* `month` - Charge based on month(s)\n* `year` - Charge based on year(s)",
                            "enum" : [ "day", "week", "month", "year" ],
                            "example" : null
                          },
                          "is_not" : {
                            "type" : "string",
                            "description" : "* `day` - Charge based on day(s)\n* `week` - Charge based on week(s)\n* `month` - Charge based on month(s)\n* `year` - Charge based on year(s)",
                            "enum" : [ "day", "week", "month", "year" ],
                            "example" : null
                          },
                          "in" : {
                            "type" : "string",
                            "description" : "* `day` - Charge based on day(s)\n* `week` - Charge based on week(s)\n* `month` - Charge based on month(s)\n* `year` - Charge based on year(s)",
                            "enum" : [ "day", "week", "month", "year" ],
                            "pattern" : "^\\[(day|week|month|year)(,(day|week|month|year))*\\]$",
                            "example" : null
                          },
                          "not_in" : {
                            "type" : "string",
                            "description" : "* `day` - Charge based on day(s)\n* `week` - Charge based on week(s)\n* `month` - Charge based on month(s)\n* `year` - Charge based on year(s)",
                            "enum" : [ "day", "week", "month", "year" ],
                            "pattern" : "^\\[(day|week|month|year)(,(day|week|month|year))*\\]$",
                            "example" : null
                          }
                        }
                      },
                      "trial_period" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "The free time window for your customer to try your product\n",
                        "example" : "14",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "format" : "number",
                            "pattern" : "^-?\\d+$",
                            "example" : null
                          },
                          "is_not" : {
                            "type" : "string",
                            "format" : "number",
                            "pattern" : "^-?\\d+$",
                            "example" : null
                          },
                          "lt" : {
                            "type" : "string",
                            "format" : "number",
                            "pattern" : "^-?\\d+$",
                            "example" : null
                          },
                          "lte" : {
                            "type" : "string",
                            "format" : "number",
                            "pattern" : "^-?\\d+$",
                            "example" : null
                          },
                          "gt" : {
                            "type" : "string",
                            "format" : "number",
                            "pattern" : "^-?\\d+$",
                            "example" : null
                          },
                          "gte" : {
                            "type" : "string",
                            "format" : "number",
                            "pattern" : "^-?\\d+$",
                            "example" : null
                          },
                          "between" : {
                            "type" : "string",
                            "pattern" : "^\\[-?\\d+,-?\\d+\\]$",
                            "example" : null
                          },
                          "is_present" : {
                            "type" : "string",
                            "format" : "boolean",
                            "enum" : [ "true", "false" ],
                            "example" : null
                          }
                        }
                      },
                      "trial_period_unit" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "Time unit for the trial period.\n",
                        "example" : "day",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "description" : "* `day` - In days\n* `month` - In months",
                            "enum" : [ "day", "month" ],
                            "example" : null
                          },
                          "is_not" : {
                            "type" : "string",
                            "description" : "* `day` - In days\n* `month` - In months",
                            "enum" : [ "day", "month" ],
                            "example" : null
                          },
                          "in" : {
                            "type" : "string",
                            "description" : "* `day` - In days\n* `month` - In months",
                            "enum" : [ "day", "month" ],
                            "pattern" : "^\\[(day|month)(,(day|month))*\\]$",
                            "example" : null
                          },
                          "not_in" : {
                            "type" : "string",
                            "description" : "* `day` - In days\n* `month` - In months",
                            "enum" : [ "day", "month" ],
                            "pattern" : "^\\[(day|month)(,(day|month))*\\]$",
                            "example" : null
                          }
                        }
                      },
                      "addon_applicability" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "Indicates if all or only some addons are applicable with the plan.\n",
                        "example" : "all",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "description" : "* `all` - All addons are applicable with this plan.\n* `restricted` - Only addons marked as 'applicable_addons' are applicable with the plan.",
                            "enum" : [ "all", "restricted" ],
                            "example" : null
                          },
                          "is_not" : {
                            "type" : "string",
                            "description" : "* `all` - All addons are applicable with this plan.\n* `restricted` - Only addons marked as 'applicable_addons' are applicable with the plan.",
                            "enum" : [ "all", "restricted" ],
                            "example" : null
                          },
                          "in" : {
                            "type" : "string",
                            "description" : "* `all` - All addons are applicable with this plan.\n* `restricted` - Only addons marked as 'applicable_addons' are applicable with the plan.",
                            "enum" : [ "all", "restricted" ],
                            "pattern" : "^\\[(all|restricted)(,(all|restricted))*\\]$",
                            "example" : null
                          },
                          "not_in" : {
                            "type" : "string",
                            "description" : "* `all` - All addons are applicable with this plan.\n* `restricted` - Only addons marked as 'applicable_addons' are applicable with the plan.",
                            "enum" : [ "all", "restricted" ],
                            "pattern" : "^\\[(all|restricted)(,(all|restricted))*\\]$",
                            "example" : null
                          }
                        }
                      },
                      "giftable" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "Specifies if the plan should be gifted or not.\n",
                        "example" : "true",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "format" : "boolean",
                            "enum" : [ "true", "false" ],
                            "example" : null
                          }
                        }
                      },
                      "status" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "The plan state\n",
                        "example" : "active",
                        "properties" : {
                          "is" : {
                            "type" : "string",
                            "description" : "* `active` - New subscriptions can be created with the plan.\n* `archived` - No new subscriptions allowed for the plan. Existing subscriptions on this plan will remain as-is and can be migrated to  another active plan if required.\n* `deleted` - Indicates the plan has been deleted.",
                            "enum" : [ "active", "archived", "deleted" ],
                            "example" : null
                          },
                          "is_not" : {
                            "type" : "string",
                            "description" : "* `active` - New subscriptions can be created with the plan.\n* `archived` - No new subscriptions allowed for the plan. Existing subscriptions on this plan will remain as-is and can be migrated to  another active plan if required.\n* `deleted` - Indicates the plan has been deleted.",
                            "enum" : [ "active", "archived", "deleted" ],
                            "example" : null
                          },
                          "in" : {
                            "type" : "string",
                            "description" : "* `active` - New subscriptions can be created with the plan.\n* `archived` - No new subscriptions allowed for the plan. Existing subscriptions on this plan will remain as-is and can be migrated to  another active plan if required.\n* `deleted` - Indicates the plan has been deleted.",
                            "enum" : [ "active", "archived", "deleted" ],
                            "pattern" : "^\\[(active|archived|deleted)(,(active|archived|deleted))*\\]$",
                            "example" : null
                          },
                          "not_in" : {
                            "type" : "string",
                            "description" : "* `active` - New subscriptions can be created with the plan.\n* `archived` - No new subscriptions allowed for the plan. Existing subscriptions on this plan will remain as-is and can be migrated to  another active plan if required.\n* `deleted` - Indicates the plan has been deleted.",
                            "enum" : [ "active", "archived", "deleted" ],
                            "pattern" : "^\\[(active|archived|deleted)(,(active|archived|deleted))*\\]$",
                            "example" : null
                          }
                        }
                      },
                      "updated_at" : {
                        "type" : "object",
                        "deprecated" : false,
                        "description" : "To filter based on updated at. This attribute will be present only if the resource has been updated after 2016-11-09.\n",
                        "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.\n",
                        "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" : {
                "plan" : {
                  "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\n"
                    }
                  },
                  "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.\n",
        "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.\n",
          "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.\n",
          "required" : true,
          "deprecated" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "format" : "date",
            "deprecated" : false,
            "example" : null
          }
        }, {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "full_export" : {
                      "$ref" : "#/components/schemas/FullExport",
                      "description" : "Resource object representing full_export\n"
                    }
                  },
                  "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.\n",
        "operationId" : "retrieve_a_payment_intent",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "payment-intent-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/payment-intent-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "payment_intent" : {
                      "$ref" : "#/components/schemas/PaymentIntent",
                      "description" : "Resource object representing payment_intent\n"
                    }
                  },
                  "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.\n",
        "operationId" : "update_a_payment_intent",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "payment-intent-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/payment-intent-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "amount" : {
                    "type" : "integer",
                    "format" : "int64",
                    "deprecated" : false,
                    "description" : "Amount(in cents) to be authorized for 3DS flow.\n",
                    "minimum" : 0,
                    "example" : null
                  },
                  "currency_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The currency code (ISO 4217 format) of the amount used in transaction.\n",
                    "maxLength" : 3,
                    "example" : null
                  },
                  "gateway_account_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The gateway account used for performing the 3DS flow.\n",
                    "maxLength" : 50,
                    "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 - Payments made via MoMo.\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 - Payments made via Rakuten Pay.\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`\nis `ideal`\n, `sofort`\n, `dotpay`\nor `giropay`\n.\n",
                    "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`\nis `ideal`\n, `sofort`\n, `dotpay`\nor `giropay`\n.\n",
                    "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.\n\n* `card`: Options for card payments.\n  * `three_d_secure`: Options for 3DS authentication.\n    * `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.\n      * `no_preference`: Chargebee, the gateway, and the issuer decide the 3DS flow.\n      * `no_challenge`: Requests a frictionless flow without a challenge.\n      * `challenge`: Requests a challenge flow.\n\nIf not specified, the existing preference is retained. To clear it, pass `payment_method_options` with no `challenge_preference`.\n",
                    "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\n"
                    }
                  },
                  "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.\n\nWhile creating, specify the appropriate gateway account and amount. Exact amount can be estimated using our [Estimate API](/docs/api/estimates).\n\n#### Customer resource lookup and creation\n\nWhen [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.\n",
        "operationId" : "create_a_payment_intent",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "customer_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "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.\n",
                    "minimum" : 0,
                    "example" : null
                  },
                  "currency_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The currency code (ISO 4217 format) of the amount used in transaction.\n",
                    "maxLength" : 3,
                    "example" : null
                  },
                  "gateway_account_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The gateway account used for performing the 3DS flow.\n",
                    "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.\n",
                    "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.\n",
                    "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 - Payments made via MoMo.\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 - Payments made via Rakuten Pay.\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`\nis `ideal`\n, `sofort`\n, `dotpay`\nor `giropay`\n.\n",
                    "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`\nis `ideal`\n, `sofort`\n, `dotpay`\nor `giropay`\n.\n",
                    "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.\n\n* `card`: Options for card payments.\n  * `three_d_secure`: Options for 3DS authentication.\n    * `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.\n      * `no_preference`: Chargebee, the gateway, and the issuer decide the 3DS flow.\n      * `no_challenge`: Requests a frictionless flow without a challenge.\n      * `challenge`: Requests a challenge flow.\n",
                    "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\n"
                    }
                  },
                  "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 the meta data",
        "description" : "Retrieves the configuration for the [custom field](/docs/api/advanced-features#custom-fields) that matches the specified entity type and API name.\n",
        "operationId" : "retrieve_the_meta_data",
        "parameters" : [ {
          "name" : "entity_type",
          "in" : "query",
          "description" : "Allowed entity types for custom fields.\n\n* customer - Entity that represents a customer.\n* invoice - Entity that represents an invoice.\n* addon_item - Entity that represents item of type addon.\n* plan - Entity that represents a subscription plan.\n* subscription - Entity that represents a subscription of a customer.\n* charge_price - Entity that represents charge price.\n* item_family - Entity that represents item family.\n* addon - Entity that represents an addon.\n* addon_price - Entity that represents addon price.\n* credit_note - Entity that represents a credit note.\n* charge_item - Entity that represents item of type charge.\n* plan_item - Entity that represents item of type plan.\n* plan_price - Entity that represents plan price.\n",
          "required" : true,
          "deprecated" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "deprecated" : false,
            "enum" : [ "customer", "subscription", "plan", "addon", "invoice", "credit_note", "plan_item", "addon_item", "charge_item", "plan_price", "addon_price", "charge_price", "coupon", "quote" ],
            "example" : null
          }
        }, {
          "name" : "api_name",
          "in" : "query",
          "description" : "Unique identifier for the custom field, used in API requests and responses.\n",
          "required" : true,
          "deprecated" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 50,
            "example" : null
          }
        }, {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "custom_field_config" : {
                      "$ref" : "#/components/schemas/CustomFieldConfig",
                      "description" : "Resource object representing custom_field_config.\n"
                    }
                  },
                  "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 configs",
        "description" : "Lists the configurations for all [custom fields](/docs/api/advanced-features#custom-fields) defined for the specified entity type.\n",
        "operationId" : "list_custom_field_configs",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "limit",
          "in" : "query",
          "description" : "The number of resources to be returned.\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`\nto the value of `next_offset`\nobtained in the previous iteration of the API call.\n",
          "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.\n\n* customer - Entity that represents a customer.\n* invoice - Entity that represents an invoice.\n* addon_item - Entity that represents item of type addon.\n* plan - Entity that represents a subscription plan.\n* subscription - Entity that represents a subscription of a customer.\n* charge_price - Entity that represents charge price.\n* item_family - Entity that represents item family.\n* addon - Entity that represents an addon.\n* addon_price - Entity that represents addon price.\n* credit_note - Entity that represents a credit note.\n* charge_item - Entity that represents item of type charge.\n* plan_item - Entity that represents item of type plan.\n* plan_price - Entity that represents plan price.\n",
          "required" : false,
          "deprecated" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "deprecated" : false,
            "enum" : [ "customer", "subscription", "plan", "addon", "invoice", "credit_note", "plan_item", "addon_item", "charge_item", "plan_price", "addon_price", "charge_price", "coupon", "quote" ],
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "list" : {
                      "type" : "array",
                      "items" : {
                        "type" : "object",
                        "properties" : {
                          "custom_field_config" : {
                            "$ref" : "#/components/schemas/CustomFieldConfig",
                            "description" : "Resource object representing custom_field_config"
                          }
                        },
                        "required" : [ "custom_field_config" ],
                        "example" : null
                      },
                      "example" : null
                    },
                    "next_offset" : {
                      "type" : "string",
                      "description" : "This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.",
                      "maxLength" : 1000,
                      "example" : null
                    }
                  },
                  "required" : [ "list" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/configurations" : {
      "get" : {
        "tags" : [ "configurations" ],
        "summary" : "List site configurations",
        "description" : "Returns a list of your domain and product catalog version details.\n",
        "operationId" : "list_site_configurations",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "configurations" : {
                      "type" : "array",
                      "description" : "Resource object representing configuration\n",
                      "items" : {
                        "$ref" : "#/components/schemas/Configuration",
                        "description" : "Resource object representing configuration"
                      },
                      "example" : null
                    }
                  },
                  "required" : [ "configurations" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/in_app_subscriptions/{in-app-subscription-app-id}/retrieve" : {
      "post" : {
        "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.\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" : "retrieve_store_subscription",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "in-app-subscription-app-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/in-app-subscription-app-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "receipt" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "**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.\n**Google Play Store** : The purchase `token` taken from the Android device after the successful creation of an in-app purchase subscription.\n",
                    "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\n",
                      "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`\nfor 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   * `plan_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  * `plan_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" : "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.\n**Google Play Store** : The purchase `token` taken from the Android device after the successful creation of an in-app purchase subscription.\n",
                    "maxLength" : 65000,
                    "example" : null
                  },
                  "product" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for product\n",
                    "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.\n**Google Play Store** : This parameter is **not applicable** to the Google Play Store. If the value is passed, it will return a validation error.\n",
                        "maxLength" : 3,
                        "example" : null
                      }
                    },
                    "required" : [ "currency_code" ],
                    "example" : null
                  },
                  "customer" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for customer\n",
                    "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.\n**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.\n",
                        "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.\n**Google Play Store**: The email ID of the customer who made this purchase.\n",
                        "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\n",
                      "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 the `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   * `plan_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`.\n\n#### 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" : "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\n",
                    "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.\n",
                        "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`.\n",
                        "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.\n",
                        "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.\n",
                        "example" : null
                      },
                      "product_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The unique identifier of the product as configured in App Store Connect.\n",
                        "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)\n) for the product.\n",
                        "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).\nThis must be unique across subscriptions.\n",
                        "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`\n.\n",
                        "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\n",
                    "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.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "The email ID of the customer who made this purchase.\n",
                        "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\n"
                    }
                  },
                  "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/v2/pcv-1/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 [plan_id](/docs/api/v2/pcv-1/plans/plan-object#id) that matches the concatenation of `product[id]` and `priceCurrencyCode` from Apple, and if not found, create such a plan.\n2. Create/update a subscription:\n\n* If the token is for a new purchase, a new subscription is created for the plan described in the previous step. The subscription has the following details:\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/1.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 **token** with Google Play Store and does the following once validation succeeds:\n\n1. Look for [plan_id](/docs/api/v2/pcv-1/plans/plan-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) from Google, and if not found, create such a plan.\n2. Create/update a subscription:\n\n* If the token is for a new purchase, a new subscription is created for the plan described in the previous step. The subscription has the following details:\n\n* `id` set to 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/v2/pcv-1/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/v2/pcv-1/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.\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" : "process_purchase_command",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "in-app-subscription-app-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/in-app-subscription-app-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "receipt" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "**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.\n**Google Play Store** : The purchase `token` taken from the Android device after the successful creation of an in-app purchase subscription.\n",
                    "maxLength" : 65000,
                    "example" : null
                  },
                  "product" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for product\n",
                    "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** :\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 currency code (ISO 4217 format) for the product.\n",
                        "maxLength" : 3,
                        "example" : null
                      },
                      "price" : {
                        "type" : "integer",
                        "format" : "int32",
                        "deprecated" : false,
                        "description" : "**Google Play Store** :\nThis parameter is **not applicable** to 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). Provide either this or `product[price_in_decimal]`.  \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** :\nThe name (created in [Play Store Console](https://play.google.com/console/about/)\n) of the product purchased. If not passed then the `product[id]`\nwill be considered as the value of `product[name]`\n.\noptional, string, max chars=46\n\n**Apple App Store** :\nThe name (created in [App Store Connect](https://appstoreconnect.apple.com/login)\n) of the product purchased.\n",
                        "maxLength" : 46,
                        "example" : null
                      },
                      "price_in_decimal" : {
                        "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** :\nThe 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]`\n.\n",
                        "maxLength" : 39,
                        "example" : null
                      },
                      "period" : {
                        "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 renewal period of the subscription. For example, 1, 2, 3, and so on. This is an `optional`\nparameter. The parameter value is `required`\nif the product(s) are not imported to Chargebee from Apple App Store.\n",
                        "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`.\nThis is an `optional`\nparameter. The parameter value is `required`\nif 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\n",
                    "properties" : {
                      "id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "**Google Play Store** :\nThe unique [id](/docs/api/customers/create-a-customer#id)\nin Chargebee for the customer who made this purchase via Google Play Store. If not provided, `subscription_id`\n(random unique id) will be the `customer[id]`.\nIf the customer record is not found in Chargebee, it is created.\noptional, string, max chars=50\n\n**Apple App Store** :\nThe unique [id](/docs/api/customers/create-a-customer#id)\nin 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)\n(the transaction identifier at Apple, of the original purchase). If the customer record is not found in Chargebee, it is created.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "The email address of the customer who made the purchase.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The first name of the customer who made the purchase.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The last name of the customer who made the purchase.\n",
                        "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\n"
                    }
                  },
                  "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.\n",
        "operationId" : "one_time_purchase",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "non-subscription-app-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/non-subscription-app-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "receipt" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "**Google Play Store** :\nThe purchase `token`\ntaken from the Android device after successful creation of the in-app purchase.\n\n**Apple App Store** :\nThe 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)\ntaken from the Apple device after successful creation of the in-app purchase.\n",
                    "maxLength" : 65000,
                    "example" : null
                  },
                  "product" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for product\n",
                    "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** :\nThis parameter is **not applicable**\nto the **Google Play Store**.\nIf the value is passed, it will return a validation error.\n\n**Apple App Store**:\nThe currency code (ISO 4217 format) for the product.\n",
                        "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**.\nIf 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).\nProvide either this or `product[price_in_decimal]`\n.\n",
                        "minimum" : 0,
                        "example" : null
                      },
                      "type" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The type of product for one time purchase.\n\n* 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.\n* 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.\n* 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.\n",
                        "enum" : [ "consumable", "non_consumable", "non_renewing_subscription" ],
                        "example" : null
                      },
                      "name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "**Google Play Store** :\nThe name (created in [Play Store Console](https://play.google.com/console/about/)\n) of the product purchased. If not passed then the `product[id]`\nwill be considered as the value of `product[name]`.\n\n**Apple App Store** :\nThe name (created in [App Store Connect](https://appstoreconnect.apple.com/login)\n) of the product purchased.\n",
                        "maxLength" : 96,
                        "example" : null
                      },
                      "price_in_decimal" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "**Google Play Store** :\nThis parameter is **not applicable** to the **Google Play Store**. If the value is passed, it will return a validation error.\n\n**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]`.\n",
                        "maxLength" : 39,
                        "example" : null
                      }
                    },
                    "required" : [ "currency_code", "id", "price", "type" ],
                    "example" : null
                  },
                  "customer" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for customer\n",
                    "properties" : {
                      "id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "**Google Play Store** :\nThe unique [id](/docs/api/customers/create-a-customer#id)\nin 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]`.\nIf the customer record is not found in Chargebee, it is created.\n\n**Apple App Store** :\nThe unique [id](/docs/api/customers/create-a-customer#id)\nin 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)\n(the transaction identifier at Apple, of the original purchase). If the customer record is not found in Chargebee, it is created.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "The email address of the customer who made the purchase.\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The first name of the customer who made the purchase.\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The last name of the customer who made the purchase.\n",
                        "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\n"
                    }
                  },
                  "required" : [ "non_subscription" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/customers/{customer-id}/payment_vouchers" : {
      "get" : {
        "tags" : [ "customers" ],
        "summary" : "List vouchers for a customer",
        "description" : "Retrieves vouchers for a customer in reverse chronological order.\n",
        "operationId" : "list_vouchers_for_a_customer",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "customer-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/customer-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        }, {
          "name" : "limit",
          "in" : "query",
          "description" : "The number of resources to be returned.\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`\nto the value of `next_offset`\nobtained in the previous iteration of the API call.\n",
          "required" : false,
          "deprecated" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "maxLength" : 1000,
            "example" : null
          }
        }, {
          "name" : "status",
          "in" : "query",
          "description" : "optional, enumerated string filter\n\nCurrent status of Payment Voucher. Possible values are : active, consumed, expired, failure.\n\n**Supported operators :**\nis, is_not, in, not_in, in, not_in\n\n**Example →**\n*status\\[is\\] = \"active, consumed, expired\"*\n",
          "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\n* `consumed` - Consumed for a transaction and cannot be used again\n* `expired` - Expired before consumed and cannot be used again\n* `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\n* `consumed` - Consumed for a transaction and cannot be used again\n* `expired` - Expired before consumed and cannot be used again\n* `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\n* `consumed` - Consumed for a transaction and cannot be used again\n* `expired` - Expired before consumed and cannot be used again\n* `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\n* `consumed` - Consumed for a transaction and cannot be used again\n* `expired` - Expired before consumed and cannot be used again\n* `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\n\nSorts based on the specified attribute.\n**Supported attributes :**\ndate, updated_at\n\n**Supported sort-orders :**\nasc, desc\n\n**Example →**\n*sort_by\\[asc\\] = \"date\"*\n\nThis will sort the result based on the 'date' attribute in ascending(earliest first) order.\n",
          "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`.\n",
                      "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.\n",
        "operationId" : "list_vouchers_for_an_invoice",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "invoice-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/invoice-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        }, {
          "name" : "limit",
          "in" : "query",
          "description" : "The number of resources to be returned.\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`\nto the value of `next_offset`\nobtained in the previous iteration of the API call.\n",
          "required" : false,
          "deprecated" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "maxLength" : 1000,
            "example" : null
          }
        }, {
          "name" : "status",
          "in" : "query",
          "description" : "optional, enumerated string filter\n\nCurrent status of Payment Voucher. Possible values are : active, consumed, expired, failure.\n\n**Supported operators :**\nis, is_not, in, not_in, in, not_in\n\n**Example →**\n*status\\[is\\] = \"active, consumed, expired\"*\n",
          "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\n* `consumed` - Consumed for a transaction and cannot be used again\n* `expired` - Expired before consumed and cannot be used again\n* `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\n* `consumed` - Consumed for a transaction and cannot be used again\n* `expired` - Expired before consumed and cannot be used again\n* `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\n* `consumed` - Consumed for a transaction and cannot be used again\n* `expired` - Expired before consumed and cannot be used again\n* `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\n* `consumed` - Consumed for a transaction and cannot be used again\n* `expired` - Expired before consumed and cannot be used again\n* `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\n\nSorts based on the specified attribute.\n**Supported attributes :**\ndate, updated_at\n\n**Supported sort-orders :**\nasc, desc\n\n**Example →**\n*sort_by\\[asc\\] = \"date\"*\n\nThis will sort the result based on the 'date' attribute in ascending(earliest first) order.\n",
          "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`.\n",
                      "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`\n.\n",
        "operationId" : "retrieve_voucher_data",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "payment-voucher-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/payment-voucher-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "payment_voucher" : {
                      "$ref" : "#/components/schemas/PaymentVoucher",
                      "description" : "Resource object representing payment_voucher\n"
                    }
                  },
                  "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.\n",
        "operationId" : "create_a_voucher_for_the_customer_to_initiate_payment",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "customer_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The unique identifier of the customer for whom you want to create the voucher.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "payment_source_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The identifier of the payment source used for generating the voucher.\n",
                    "maxLength" : 40,
                    "example" : null
                  },
                  "voucher_payment_source" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for voucher_payment_source\n",
                    "properties" : {
                      "voucher_type" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The type of voucher-based payment source.\n\n* boleto - The payment source is Boleto.\n",
                        "enum" : [ "boleto" ],
                        "example" : null
                      }
                    },
                    "required" : [ "voucher_type" ],
                    "example" : null
                  },
                  "invoice_allocations" : {
                    "type" : "object",
                    "deprecated" : false,
                    "description" : "Parameters for `invoice_allocations`\n",
                    "properties" : {
                      "invoice_id" : {
                        "type" : "array",
                        "description" : "The unique identifier of the invoice. You can pass multiple invoices ID.\n",
                        "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\n"
                    }
                  },
                  "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
          }
        } ],
        "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`\n`forex_type`\ncurrency.\n",
        "operationId" : "add_schedule",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "site-currency-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/site-currency-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "manual_exchange_rate" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "This parameter allows you to pass the exchange rate in decimal format. When `forex_type`\nis `manual`\nyou have to set the exchange rate for additional currencies in `manual_exchange_rate`\nparameter. A maximum of **nine**\ndecimal values are allowed to pass in this field.\n",
                    "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.\n",
                    "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 exchange rate scheduled has to be updated in your site.\n",
                      "example" : null
                    },
                    "currency" : {
                      "$ref" : "#/components/schemas/Currency",
                      "description" : "Resource object representing currency\n"
                    }
                  },
                  "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/1.0/multi-currency-pricing.html#1-adding-and-managing-currencies)\nis enabled.\nIf the `forex_type`\nis set to `manual`\n, you can specify the `manual_exchange_rate`\n. Additionally, the currency code provided must adhere to the three-letter ISO standard currency codes.\n",
        "operationId" : "add_a_new_currency",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "currency_code" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "A three letter currency code. For example, GBR, INR, and more.\n",
                    "maxLength" : 3,
                    "example" : null
                  },
                  "forex_type" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "This represents the exchange rate type set for the currency.\n\n* auto -\n  If `forex_type`\n  is `auto`\n  , conversion rate will be auto updated by Chargebee every day with third party providers (using external currency conversion providers)\n* manual -\n  If `forex_type`\n  is `manual`\n  , 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\n",
                    "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`\nis `manual`\nyou have to set the exchange rate for additional currencies in `manual_exchange_rate`\nparameter. A maximum of **nine**\ndecimal values are allowed to pass in this field.\n",
                    "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\n"
                    }
                  },
                  "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.\n",
        "operationId" : "retrieve_a_currency",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "site-currency-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/site-currency-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "currency" : {
                      "$ref" : "#/components/schemas/Currency",
                      "description" : "Resource object representing currency\n"
                    }
                  },
                  "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.\nAdditionally, If the `forex_type`\nis set to `manual`\n, you can specify the `manual_exchange_rate`\n.\n",
        "operationId" : "update_a_currency",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "site-currency-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/site-currency-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "forex_type" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "This represents the exchange rate type set for the currency.\n\n* auto -\n  If `forex_type`\n  is `auto`\n  , conversion rate will be auto updated by Chargebee every day with third party providers (using external currency conversion providers)\n* manual -\n  If `forex_type`\n  is `manual`\n  , 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\n",
                    "enum" : [ "manual", "auto" ],
                    "example" : null
                  },
                  "manual_exchange_rate" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "TThis parameter allows you to pass the exchange rate in decimal format. When `forex_type`\nis `manual`\nyou have to set the exchange rate for additional currencies in `manual_exchange_rate`\nparameter. A maximum of **nine**\ndecimal values are allowed to pass in this field.\n",
                    "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\n"
                    }
                  },
                  "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.\n",
        "operationId" : "remove_schedule",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "site-currency-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/site-currency-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "scheduled_at" : {
                      "type" : "integer",
                      "format" : "unix-time",
                      "deprecated" : false,
                      "description" : "Timestamp at which the exchange rate scheduled has to be updated in your site.\n",
                      "example" : null
                    },
                    "currency" : {
                      "$ref" : "#/components/schemas/Currency",
                      "description" : "Resource object representing currency\n"
                    }
                  },
                  "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.\n",
        "operationId" : "list_currencies",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "limit",
          "in" : "query",
          "description" : "The number of resources to be returned.\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.\n",
          "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`.\n",
                      "maxLength" : 1000,
                      "example" : null
                    }
                  },
                  "required" : [ "list" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/pc2_migrations/{pc2-migration-id}/contact_support" : {
      "post" : {
        "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" : "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" : "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
          }
        } ],
        "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" : "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" : "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" : "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" : "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" : "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
          }
        } ],
        "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" : "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" : "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" : "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" : "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
          }
        } ],
        "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" : "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" : "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\n* `addon` - ADDON",
                "enum" : [ "plan", "addon" ],
                "example" : null
              },
              "is_not" : {
                "type" : "string",
                "description" : "* `plan` - PLAN\n* `addon` - ADDON",
                "enum" : [ "plan", "addon" ],
                "example" : null
              },
              "in" : {
                "type" : "string",
                "description" : "* `plan` - PLAN\n* `addon` - ADDON",
                "enum" : [ "plan", "addon" ],
                "pattern" : "^\\[(plan|addon)(,(plan|addon))*\\]$",
                "example" : null
              },
              "not_in" : {
                "type" : "string",
                "description" : "* `plan` - PLAN\n* `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" : "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" : "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" : "pc2-migration-item-price-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/pc2-migration-item-price-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "name" : {
                    "type" : "string",
                    "deprecated" : false,
                    "maxLength" : 100,
                    "example" : null
                  },
                  "pc2_migration_item_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "maxLength" : 100,
                    "example" : null
                  },
                  "description" : {
                    "type" : "string",
                    "deprecated" : false,
                    "maxLength" : 500,
                    "example" : null
                  },
                  "metadata" : {
                    "type" : "string",
                    "deprecated" : false,
                    "maxLength" : 500,
                    "example" : null
                  },
                  "sanitized_pc1_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "maxLength" : 100,
                    "example" : null
                  },
                  "is_primary_attached_item" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "example" : null
                  }
                },
                "example" : null
              },
              "encoding" : { }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "pc2_migration_item_price" : {
                      "$ref" : "#/components/schemas/Pc2MigrationItemPrice",
                      "description" : "Resource object representing pc2_migration_item_price"
                    }
                  },
                  "required" : [ "pc2_migration_item_price" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/site_pc_meta_records" : {
      "get" : {
        "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" : "limit",
          "in" : "query",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/limit",
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "integer",
            "format" : "int32",
            "default" : 10,
            "description" : "The number of resources to be returned.",
            "maximum" : 100,
            "minimum" : 1,
            "example" : null
          }
        }, {
          "name" : "offset",
          "in" : "query",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/offset",
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.",
            "maxLength" : 1000,
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "list" : {
                      "type" : "array",
                      "items" : {
                        "type" : "object",
                        "properties" : {
                          "site_pc_meta_record" : {
                            "$ref" : "#/components/schemas/SitePcMetaRecord",
                            "description" : "Resource object representing site_pc_meta_record"
                          }
                        },
                        "required" : [ "site_pc_meta_record" ],
                        "example" : null
                      },
                      "example" : null
                    },
                    "next_offset" : {
                      "type" : "string",
                      "description" : "This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.",
                      "maxLength" : 1000,
                      "example" : null
                    }
                  },
                  "required" : [ "list" ],
                  "example" : null
                }
              }
            }
          },
          "400" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/400"
                }
              }
            }
          },
          "401" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/401"
                }
              }
            }
          },
          "403" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/403"
                }
              }
            }
          },
          "404" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/404"
                }
              }
            }
          },
          "405" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/405"
                }
              }
            }
          },
          "409" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/409"
                }
              }
            }
          },
          "422" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/422"
                }
              }
            }
          },
          "429" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/429"
                }
              }
            }
          },
          "500" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/500"
                }
              }
            }
          },
          "503" : {
            "description" : "on error",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/503"
                }
              }
            }
          }
        },
        "deprecated" : false,
        "security" : [ {
          "BasicAuth" : [ ]
        } ]
      }
    },
    "/rules/{rule-id}" : {
      "get" : {
        "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" : "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" : [ ]
        } ]
      }
    },
    "/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.\n",
        "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" : "limit",
          "in" : "query",
          "description" : "The number of resources to be returned.\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`\nto the value of `next_offset`\nobtained in the previous iteration of the API call.\n",
          "required" : false,
          "deprecated" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : "string",
            "maxLength" : 1000,
            "example" : null
          }
        }, {
          "name" : "id",
          "in" : "query",
          "description" : "optional, string filter\n\nThe unique id for the e-invoice.\n**Supported operators :**\nis, in\n\n**Example →**\n*id\\[is\\] = \"HmaT0avT2mtbTL3mR\"*\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "example" : "HmaT0avT2mtbTL3mR",
            "properties" : {
              "is" : {
                "type" : "string",
                "minLength" : 1,
                "example" : null
              },
              "in" : {
                "type" : "string",
                "pattern" : "^\\[(.*)(,.*)*\\]$",
                "example" : null
              }
            }
          }
        }, {
          "name" : "reference_id",
          "in" : "query",
          "description" : "optional, string filter\n\nIdentifier returned by the connected e-invoicing provider for this submission.\n**Supported operators :**\nis, in\n\n**Example →**\n*reference_id\\[is\\] = \"einvoice_ref_123\"*\n",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "example" : "einvoice_ref_123",
            "properties" : {
              "is" : {
                "type" : "string",
                "minLength" : 1,
                "example" : null
              },
              "in" : {
                "type" : "string",
                "pattern" : "^\\[(.*)(,.*)*\\]$",
                "example" : null
              }
            }
          }
        }, {
          "name" : "updated_at",
          "in" : "query",
          "description" : "optional, timestamp(UTC) in seconds filter\n\nFilter e-invoices based on `updated_at`. Useful for downstream delta sync.\nIt is advisable when using this filter, to pass the `sort_by`\ninput parameter as `updated_at`\nfor a faster response.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*updated_at\\[after\\] = \"1243545465\"*\n",
          "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\n\nSorts based on the specified attribute.\n**Supported attributes :**\nupdated_at\n\n**Supported sort-orders :**\nasc, desc\n\n**Example →**\n*sort_by\\[desc\\] = \"updated_at\"*\n\nThis will sort the result based on the 'updated_at' attribute in descending (latest first) order.\nWhen omitted, the list defaults to `updated_at` descending (with `id` as tiebreaker).\n",
          "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`).\n",
        "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" : "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\n"
                    }
                  },
                  "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.\nYou 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.\n\nSystem evaluates eligibility and mapping to the right offer based on:\n\n* Customer profile and subscription information.\n* Device and browsing context.\n* Custom fields.\n* Play configurations.\n\nIf no eligible offers are found, the API returns an empty list. (No error is thrown in this case; an empty result is a valid response).\n\n**Features of this API**\n\nThe List Personalized Offers endpoint allows you to:\n\n* Retrieve context-aware offers targeted to customers or end users.\n* Leverage multiple signals (profile, subscription, device/browser context, custom fields, and plays).\n* 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).\n* Support both B2C (single user per customer) and B2B (multiple end users per customer) scenarios. **Note:** Although the response is modeled as a list, the API currently returns at most one personalized offer (the best-matched offer for the user). If no offers are available, the list will be empty.\n",
        "operationId" : "list_personalized_offers",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "first_name" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "First name of the customer. Will be ignored if not mapped to any field in the [settings](https://www.chargebee.com/docs/retention/chargebee-billing-integration.html#syncing-and-mapping-chargebee-fields-into-chargebee-retention)\n.\n",
                    "maxLength" : 150,
                    "example" : null
                  },
                  "last_name" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Last name of the customer. Will be ignored if not mapped to any field in the [settings](https://www.chargebee.com/docs/retention/chargebee-billing-integration.html#syncing-and-mapping-chargebee-fields-into-chargebee-retention)\n.\n",
                    "maxLength" : 150,
                    "example" : null
                  },
                  "email" : {
                    "type" : "string",
                    "format" : "email",
                    "deprecated" : false,
                    "description" : "Customer's email address. Will be ignored if not mapped to any field in the [settings](https://www.chargebee.com/docs/retention/chargebee-billing-integration.html#syncing-and-mapping-chargebee-fields-into-chargebee-retention)\n.\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",
                    "items" : {
                      "type" : "string",
                      "deprecated" : false,
                      "maxLength" : 50,
                      "example" : null
                    },
                    "example" : null
                  },
                  "external_user_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The unique identifier of the user in the merchant's system. This is used to identify the user for whom the offer is being created.\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.\n**Notes:**\n\n* **Required** if multiple brands are configured in your Growth application.\n* **Recommended** to always provide.\n* If omitted and the customer has multiple subscriptions, the system attempts to retrieve the offer associated with one of their subscriptions.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "customer_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The ID of the customer in the billing system (Chargebee customer ID).\n",
                    "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",
                    "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.\n",
                    "properties" : {
                      "user_agent" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The user's browser or device user agent string. Helps determine browser and platform details.\nFor example, chrome/7.10\n",
                        "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.\n",
                        "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.\n",
                        "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.\n",
                        "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.\n",
                        "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.\n",
                      "items" : {
                        "$ref" : "#/components/schemas/PersonalizedOffer",
                        "description" : "Resource object representing personalized_offer"
                      },
                      "example" : null
                    },
                    "brand" : {
                      "$ref" : "#/components/schemas/Brand",
                      "description" : "Resource object representing brand\n"
                    },
                    "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.\n",
                      "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.\nYou can call this API when a user accepts an offer (e.g., the user clicked Accept Offer or a similar confirmation).\nThis API will record an accepted event as soon as the API is called and initiate the appropriate fulfillment mechanism according to `processing_type`:\n\n* `billing_update`: Initiates subscription or billing record updates (e.g., applying a discount or changing a plan) asynchronously.\n* `checkout`: Returns a `hosted_page` object in the response, which contains a URL to render the hosted checkout flow.\n* `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.\n* `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.\n* `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.\n",
        "operationId" : "create_an_offer_fulfillment",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "personalized_offer_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "ID of the personalized offer that was accepted.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "option_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "ID of the Offer Option that the user accepted.\n",
                    "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.\n"
                    },
                    "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`\nis checkout.\n"
                    }
                  },
                  "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).\n",
        "operationId" : "retrieve_an_offer_fulfillment",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "offer-fulfillment-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/offer-fulfillment-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "offer_fulfillment" : {
                      "$ref" : "#/components/schemas/OfferFulfillment",
                      "description" : "Represents the fulfillment created for the offer.\n"
                    }
                  },
                  "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.\n\nIf `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`.\n\n**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`.\n",
        "operationId" : "update_an_offer_fulfillment",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "offer-fulfillment-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/offer-fulfillment-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "ID of the fulfillment that is being updated.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "status" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Final state of the fulfillment.\n\n* failed - Pass this if the fulfillment is failed.\n* completed - Pass this if the fulfillment is completed.\n",
                    "enum" : [ "completed", "failed" ],
                    "example" : null
                  },
                  "failure_reason" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Explanation for failure; required when `status`\n= `failed`\n.\n",
                    "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.\n"
                    }
                  },
                  "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.\n\nUse this API to log user-triggered engagement events such as:\n\n* `viewed` - when an offer is displayed to the user.\n* `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.\n\n**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.\n",
        "operationId" : "create_an_offer_event",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "personalized_offer_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The ID of the personalized offer the event pertains to.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "type" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The type of engagement event to be recorded.\n\n* dismissed - Logged when the user closes or ignores the offer without accepting\n* viewed - Logged when the user's UI renders or displays the offer\n",
                    "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.\n",
        "operationId" : "delete_a_webhook_endpoint",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "webhook-endpoint-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/webhook-endpoint-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "webhook_endpoint" : {
                      "$ref" : "#/components/schemas/WebhookEndpoint",
                      "description" : "The `webhook_endpoint`\nresource object that contains the configuration and details of the created webhook.\n"
                    }
                  },
                  "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.\n",
        "operationId" : "retrieve_a_webhook_endpoint",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "webhook-endpoint-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/webhook-endpoint-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "content" : {
              "application/json" : {
                "schema" : {
                  "type" : "object",
                  "properties" : {
                    "webhook_endpoint" : {
                      "$ref" : "#/components/schemas/WebhookEndpoint",
                      "description" : "The `webhook_endpoint`\nresource object that contains the configuration and details of the created webhook.\n"
                    }
                  },
                  "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.\n",
        "operationId" : "update_a_webhook_endpoint",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "webhook-endpoint-id",
          "in" : "path",
          "required" : true,
          "deprecated" : false,
          "$ref" : "#/components/parameters/webhook-endpoint-id",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "name" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "A name to identify the webhook endpoint.\n",
                    "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.\n\n* v1 - If selected, the payload includes only attributes from API v1 resources.\n* v2 - If selected, the payload includes only attributes from API v2 resources.\n",
                    "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.\n",
                    "example" : null
                  },
                  "send_card_resource" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "Specifies whether card-related resources should be included in the webhook payload.\n",
                    "example" : null
                  },
                  "basic_auth_password" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The password used for basic authentication to secure webhook delivery.\n",
                    "maxLength" : 250,
                    "example" : null
                  },
                  "basic_auth_username" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Username for basic authentication used to secure webhook delivery.\n",
                    "maxLength" : 250,
                    "example" : null
                  },
                  "disabled" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "Indicates whether the webhook endpoint is disabled. Set to `true`\nto disable the endpoint, set to `false`\nto enable the endpoint.\n",
                    "example" : null
                  },
                  "enabled_events" : {
                    "type" : "array",
                    "deprecated" : false,
                    "description" : "A list of event types that trigger this webhook.  \n**Note**\nIf this field is left empty, the webhook will enable [all event types](/docs/api/v2/pcv-1/webhook_endpoints) by default.\n",
                    "items" : {
                      "type" : "string",
                      "deprecated" : false,
                      "enum" : [ "plan_created", "plan_updated", "plan_deleted", "addon_created", "addon_updated", "addon_deleted", "coupon_created", "coupon_updated", "coupon_deleted", "coupon_set_created", "coupon_set_updated", "coupon_set_deleted", "coupon_codes_added", "coupon_codes_deleted", "coupon_codes_updated", "customer_created", "customer_changed", "customer_deleted", "customer_moved_out", "customer_moved_in", "promotional_credits_added", "promotional_credits_deducted", "subscription_created", "subscription_created_with_backdating", "subscription_started", "subscription_trial_end_reminder", "subscription_activated", "subscription_activated_with_backdating", "subscription_changed", "subscription_trial_extended", "mrr_updated", "subscription_changed_with_backdating", "subscription_cancellation_scheduled", "subscription_cancellation_reminder", "subscription_cancelled", "subscription_canceled_with_backdating", "subscription_reactivated", "subscription_reactivated_with_backdating", "subscription_renewed", "subscription_items_renewed", "subscription_scheduled_cancellation_removed", "subscription_changes_scheduled", "subscription_scheduled_changes_removed", "subscription_shipping_address_updated", "subscription_deleted", "subscription_paused", "subscription_pause_scheduled", "subscription_scheduled_pause_removed", "subscription_resumed", "subscription_resumption_scheduled", "subscription_scheduled_resumption_removed", "subscription_advance_invoice_schedule_added", "subscription_advance_invoice_schedule_updated", "subscription_advance_invoice_schedule_removed", "pending_invoice_created", "pending_invoice_updated", "invoice_generated", "invoice_generated_with_backdating", "invoice_updated", "invoice_deleted", "credit_note_created", "credit_note_created_with_backdating", "credit_note_updated", "credit_note_deleted", "einvoice_created", "einvoice_updated", "subscription_renewal_reminder", "transaction_created", "transaction_updated", "transaction_deleted", "payment_succeeded", "payment_failed", "dunning_updated", "payment_refunded", "payment_initiated", "refund_initiated", "authorization_succeeded", "authorization_voided", "card_added", "card_updated", "card_expiry_reminder", "card_expired", "card_deleted", "payment_source_added", "payment_source_updated", "payment_source_deleted", "payment_source_expiring", "payment_source_expired", "payment_source_locally_deleted", "virtual_bank_account_added", "virtual_bank_account_updated", "virtual_bank_account_deleted", "token_created", "token_consumed", "token_expired", "unbilled_charges_created", "unbilled_charges_voided", "unbilled_charges_deleted", "unbilled_charges_invoiced", "order_created", "order_updated", "order_cancelled", "order_delivered", "order_returned", "order_ready_to_process", "order_ready_to_ship", "order_deleted", "order_resent", "quote_created", "quote_updated", "quote_deleted", "tax_withheld_recorded", "tax_withheld_deleted", "tax_withheld_refunded", "gift_scheduled", "gift_unclaimed", "gift_claimed", "gift_expired", "gift_cancelled", "gift_updated", "hierarchy_created", "hierarchy_deleted", "payment_intent_created", "payment_intent_updated", "contract_term_created", "contract_term_renewed", "contract_term_terminated", "contract_term_completed", "contract_term_cancelled", "voucher_created", "voucher_expired", "voucher_create_failed", "subscription_ramp_created", "subscription_ramp_deleted", "subscription_ramp_applied", "subscription_ramp_drafted", "subscription_ramp_updated", "subscription_moved_in", "subscription_moved_out", "subscription_movement_failed", "omnichannel_subscription_created", "omnichannel_subscription_item_renewed", "omnichannel_subscription_item_downgraded", "omnichannel_subscription_item_expired", "omnichannel_subscription_item_cancellation_scheduled", "omnichannel_subscription_item_scheduled_cancellation_removed", "omnichannel_subscription_item_resubscribed", "omnichannel_subscription_item_upgraded", "omnichannel_subscription_item_cancelled", "omnichannel_subscription_imported", "omnichannel_subscription_item_grace_period_started", "omnichannel_subscription_item_grace_period_expired", "omnichannel_subscription_item_dunning_started", "omnichannel_subscription_item_dunning_expired", "rule_created", "rule_updated", "rule_deleted", "record_purchase_failed", "omnichannel_subscription_item_change_scheduled", "omnichannel_subscription_item_scheduled_change_removed", "omnichannel_subscription_item_reactivated", "sales_order_created", "sales_order_updated", "omnichannel_subscription_item_changed", "omnichannel_subscription_item_paused", "omnichannel_subscription_item_resumed", "omnichannel_one_time_order_created", "omnichannel_one_time_order_item_cancelled", "omnichannel_subscription_item_pause_scheduled", "vault_token_created", "vault_token_updated", "vault_token_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`\nresource object that contains the configuration and details of the created webhook.\n"
                    }
                  },
                  "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.\n",
        "operationId" : "list_webhook_endpoints",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "limit",
          "in" : "query",
          "description" : "The number of resources to be returned.\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`\nto the value of `next_offset`\nobtained in the previous iteration of the API call.\n",
          "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`.\n",
                      "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 endpoint on your Chargebee Site.\n",
        "operationId" : "create_a_webhook_endpoint",
        "parameters" : [ {
          "name" : "chargebee-request-origin-device",
          "in" : "header",
          "description" : "The device from which the customer has made the request",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-device",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The device from which the customer has made the request",
            "example" : "Android"
          }
        }, {
          "name" : "chargebee-request-origin-user",
          "in" : "header",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
            "example" : "user@example.com"
          }
        }, {
          "name" : "chargebee-request-origin-user-encoded",
          "in" : "header",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "format" : "email",
            "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
            "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
          }
        }, {
          "name" : "chargebee-request-origin-ip",
          "in" : "header",
          "description" : "The IP address of the customer where the request originated",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-request-origin-ip",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "The IP address of the customer where the request originated",
            "example" : "192.168.1.2",
            "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$"
          }
        }, {
          "name" : "chargebee-event-actions",
          "in" : "header",
          "description" : "skip all actions to be done on the events",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-actions",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip all actions to be done on the events",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-email",
          "in" : "header",
          "description" : "skip only emails",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-email",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : "skip only emails",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        }, {
          "name" : "chargebee-event-webhook",
          "in" : "header",
          "description" : " skip only webhooks",
          "required" : false,
          "deprecated" : false,
          "$ref" : "#/components/parameters/chargebee-event-webhook",
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : "string",
            "description" : " skip only webhooks",
            "enum" : [ "all-disabled" ],
            "example" : null
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/x-www-form-urlencoded" : {
              "schema" : {
                "type" : "object",
                "properties" : {
                  "name" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "A name to identify the webhook endpoint.\n",
                    "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\n\n* v1 - If selected, the payload includes only attributes from API v1 resources.\n* v2 - If selected, the payload includes only attributes from API v2 resources.\n",
                    "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.\n",
                    "example" : null
                  },
                  "disabled" : {
                    "type" : "boolean",
                    "default" : false,
                    "deprecated" : false,
                    "description" : "Indicates whether the webhook endpoint is disabled. Set to `true`\nto disable the endpoint, set to `false`\nto enable the endpoint.\n",
                    "example" : null
                  },
                  "basic_auth_password" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The password used for basic authentication to secure webhook delivery.\n",
                    "maxLength" : 250,
                    "example" : null
                  },
                  "basic_auth_username" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Username for basic authentication used to secure webhook delivery.\n",
                    "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.\n",
                    "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* 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* 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",
                    "enum" : [ "plans_addons", "items", "compat" ],
                    "example" : null
                  },
                  "enabled_events" : {
                    "type" : "array",
                    "deprecated" : false,
                    "description" : "A list of event types that trigger this webhook.  \n**Note**\nIf this field is left empty, the webhook will enable [all event types](/docs/api/v2/pcv-1/webhook_endpoints) by default.\n",
                    "items" : {
                      "type" : "string",
                      "deprecated" : false,
                      "enum" : [ "plan_created", "plan_updated", "plan_deleted", "addon_created", "addon_updated", "addon_deleted", "coupon_created", "coupon_updated", "coupon_deleted", "coupon_set_created", "coupon_set_updated", "coupon_set_deleted", "coupon_codes_added", "coupon_codes_deleted", "coupon_codes_updated", "customer_created", "customer_changed", "customer_deleted", "customer_moved_out", "customer_moved_in", "promotional_credits_added", "promotional_credits_deducted", "subscription_created", "subscription_created_with_backdating", "subscription_started", "subscription_trial_end_reminder", "subscription_activated", "subscription_activated_with_backdating", "subscription_changed", "subscription_trial_extended", "mrr_updated", "subscription_changed_with_backdating", "subscription_cancellation_scheduled", "subscription_cancellation_reminder", "subscription_cancelled", "subscription_canceled_with_backdating", "subscription_reactivated", "subscription_reactivated_with_backdating", "subscription_renewed", "subscription_items_renewed", "subscription_scheduled_cancellation_removed", "subscription_changes_scheduled", "subscription_scheduled_changes_removed", "subscription_shipping_address_updated", "subscription_deleted", "subscription_paused", "subscription_pause_scheduled", "subscription_scheduled_pause_removed", "subscription_resumed", "subscription_resumption_scheduled", "subscription_scheduled_resumption_removed", "subscription_advance_invoice_schedule_added", "subscription_advance_invoice_schedule_updated", "subscription_advance_invoice_schedule_removed", "pending_invoice_created", "pending_invoice_updated", "invoice_generated", "invoice_generated_with_backdating", "invoice_updated", "invoice_deleted", "credit_note_created", "credit_note_created_with_backdating", "credit_note_updated", "credit_note_deleted", "einvoice_created", "einvoice_updated", "subscription_renewal_reminder", "transaction_created", "transaction_updated", "transaction_deleted", "payment_succeeded", "payment_failed", "dunning_updated", "payment_refunded", "payment_initiated", "refund_initiated", "authorization_succeeded", "authorization_voided", "card_added", "card_updated", "card_expiry_reminder", "card_expired", "card_deleted", "payment_source_added", "payment_source_updated", "payment_source_deleted", "payment_source_expiring", "payment_source_expired", "payment_source_locally_deleted", "virtual_bank_account_added", "virtual_bank_account_updated", "virtual_bank_account_deleted", "token_created", "token_consumed", "token_expired", "unbilled_charges_created", "unbilled_charges_voided", "unbilled_charges_deleted", "unbilled_charges_invoiced", "order_created", "order_updated", "order_cancelled", "order_delivered", "order_returned", "order_ready_to_process", "order_ready_to_ship", "order_deleted", "order_resent", "quote_created", "quote_updated", "quote_deleted", "tax_withheld_recorded", "tax_withheld_deleted", "tax_withheld_refunded", "gift_scheduled", "gift_unclaimed", "gift_claimed", "gift_expired", "gift_cancelled", "gift_updated", "hierarchy_created", "hierarchy_deleted", "payment_intent_created", "payment_intent_updated", "contract_term_created", "contract_term_renewed", "contract_term_terminated", "contract_term_completed", "contract_term_cancelled", "voucher_created", "voucher_expired", "voucher_create_failed", "subscription_ramp_created", "subscription_ramp_deleted", "subscription_ramp_applied", "subscription_ramp_drafted", "subscription_ramp_updated", "subscription_moved_in", "subscription_moved_out", "subscription_movement_failed", "omnichannel_subscription_created", "omnichannel_subscription_item_renewed", "omnichannel_subscription_item_downgraded", "omnichannel_subscription_item_expired", "omnichannel_subscription_item_cancellation_scheduled", "omnichannel_subscription_item_scheduled_cancellation_removed", "omnichannel_subscription_item_resubscribed", "omnichannel_subscription_item_upgraded", "omnichannel_subscription_item_cancelled", "omnichannel_subscription_imported", "omnichannel_subscription_item_grace_period_started", "omnichannel_subscription_item_grace_period_expired", "omnichannel_subscription_item_dunning_started", "omnichannel_subscription_item_dunning_expired", "rule_created", "rule_updated", "rule_deleted", "record_purchase_failed", "omnichannel_subscription_item_change_scheduled", "omnichannel_subscription_item_scheduled_change_removed", "omnichannel_subscription_item_reactivated", "sales_order_created", "sales_order_updated", "omnichannel_subscription_item_changed", "omnichannel_subscription_item_paused", "omnichannel_subscription_item_resumed", "omnichannel_one_time_order_created", "omnichannel_one_time_order_item_cancelled", "omnichannel_subscription_item_pause_scheduled", "vault_token_created", "vault_token_updated", "vault_token_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`\nresource object that contains the configuration and details of the created webhook.\n"
                    }
                  },
                  "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" : [ ]
        } ]
      }
    },
    "/grant_blocks" : {
      "get" : {
        "tags" : [ "grant_blocks" ],
        "summary" : "List Grant Blocks",
        "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" : "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" : "subscription_id",
          "in" : "query",
          "required" : true,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "description" : "Subscription id.",
            "properties" : {
              "is" : {
                "type" : "string",
                "minLength" : 1,
                "example" : null
              }
            },
            "example" : null
          }
        }, {
          "name" : "unit_id",
          "in" : "query",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "description" : "Unit id.",
            "properties" : {
              "is" : {
                "type" : "string",
                "minLength" : 1,
                "example" : null
              }
            },
            "example" : null
          }
        }, {
          "name" : "account_type",
          "in" : "query",
          "required" : false,
          "deprecated" : false,
          "style" : "deepObject",
          "explode" : true,
          "schema" : {
            "type" : "object",
            "deprecated" : false,
            "properties" : {
              "is" : {
                "type" : "string",
                "description" : "* `provisioned` - provisioned\n* `overdraft` - overdraft",
                "enum" : [ "provisioned", "overdraft" ],
                "example" : null
              }
            },
            "example" : null
          }
        }, {
          "name" : "effective_from",
          "in" : "query",
          "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",
          "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",
          "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",
          "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" : [ ]
        } ]
      }
    }
  },
  "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$.\n* `configuration_incompatible` - Returned when the request is not compatible with the configuration for the  site or the configuration is incomplete.\n* `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.\n* `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.\n* `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.\n* `payment_processing_failed` - Returned when the payment collection fails.\n* `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.\n* `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.\n* `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).\n* `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.\n* `resource_limit_exceeded`\n* `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.\n* `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.\n* `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.\n* `api_request_limit_exceeded` - Returned when requests have been blocked temporarily due to request count exceeding acceptable limits.\n* `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.\n* `site_read_only_mode` - Returned when your site is temporarily unavailable for write operations due to a scheduled maintenance.\n* `site_not_ready` - Returned when your site is temporarily unavailable due to a scheduled maintenance.\n* `internal_temporary_error` - Returned when temporary occured in Chargebee side. The request can be re-tried, with exponential backoff in case of repeat failures.",
            "enum" : [ "db_connection_failure", "site_read_only_mode", "site_not_ready", "internal_temporary_error" ],
            "example" : null
          }
        },
        "required" : [ "api_error_code", "message", "type" ],
        "example" : null
      },
      "AccountHolderType" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "individual", "company" ],
        "example" : null
      },
      "AccountReceivablesHandling" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "no_action", "schedule_payment_collection", "write_off" ],
        "example" : null
      },
      "AccountType" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "checking", "savings", "business_checking", "current" ],
        "example" : null
      },
      "Action" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "upsert", "remove" ],
        "example" : null
      },
      "Addon" : {
        "type" : "object",
        "additionalProperties" : true,
        "description" : "Addons are additional charges applied to a subscription apart from the base plan charge. The addons can be recurring or non-recurring. A recurring addon included in a subscription is charged as per billing frequency of subscription. A non-recurring addon included in subscription will be charged immediately and only once. And a non-recurring addon is NOT pro-rated based on billing cycle, whereas a recurring addon is automatically pro-rated based on billing cycle.\n",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "A unique ID for your system to identify the addon.\n",
            "maxLength" : 100,
            "example" : null
          },
          "name" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The display name used in web interface for identifying the addon.\n",
            "maxLength" : 100,
            "example" : null
          },
          "invoice_name" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Display name used in invoice. If it is not configured then name is used in invoice.\n",
            "maxLength" : 100,
            "example" : null
          },
          "description" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Description about the addon to show in the hosted pages \\& customer portal. This description will not be shown if multiple addons are added.\n**Note:**\n\nIf your input contains characters that are subjected to sanitization (like incomplete HTML tags), the sanitization process might increase the length of your input. If the sanitized input exceeds the limit, your request will be rejected.\n",
            "maxLength" : 2000,
            "example" : null
          },
          "pricing_model" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Defines how the charges for the addons are calculated.\n\n* tiered - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.\n* per_unit - A fixed price per unit quantity.\n* flat_fee - A fixed price that is not quantity-based.\n* volume - The per unit price is based on the tier that the total quantity falls in.\n* stairstep - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.\n",
            "enum" : [ "flat_fee", "per_unit", "tiered", "volume", "stairstep" ],
            "example" : null
          },
          "charge_type" : {
            "type" : "string",
            "default" : "recurring",
            "deprecated" : false,
            "description" : "Type of charge\n\n* non_recurring - Charged immediately and only once every time it is applied.\n* recurring - Charges are automatically applied in sync with the billing frequency of subscription.\n",
            "enum" : [ "recurring", "non_recurring" ],
            "example" : null
          },
          "price" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Addon price is calculated based on the addon type and charge type. [Learn more](https://www.chargebee.com/docs/addons.html#charge-type-and-pricing).\nThe unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
            "minimum" : 0,
            "example" : null
          },
          "currency_code" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The currency code (ISO 4217 format) of the addon\n",
            "maxLength" : 3,
            "example" : null
          },
          "period" : {
            "type" : "integer",
            "format" : "int32",
            "deprecated" : false,
            "description" : "Applicable only for recurring-addons. Along with 'period_unit' decides the term-price of this addon.\n",
            "minimum" : 1,
            "example" : null
          },
          "period_unit" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Applicable only for recurring-addons. Along with 'period' decides the term-price of this addon\n\n* month - Charge based on month(s)\n* week - Charge based on week(s)\n* not_applicable - not applicable for this addon\n* year - Charge based on year(s)\n* day - Charge based on Day(S)\n",
            "enum" : [ "day", "week", "month", "year", "not_applicable" ],
            "example" : null
          },
          "unit" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Specifies the type of quantity. For example, if the addon price is $10 and 'agent' is the unit of measure, the addon will be $10/agent.\nApplicable only for quantity type addons.\n",
            "maxLength" : 30,
            "example" : null
          },
          "status" : {
            "type" : "string",
            "default" : "active",
            "deprecated" : false,
            "description" : "Status of the addon\n\n* archived - No new associations with subscriptions are allowed. Existing associations for recurring addons remain as-is and can be removed if required.\n* active - Only active addons can be applied to subscriptions\n* deleted - Indicates the addon has been deleted.\n",
            "enum" : [ "active", "archived", "deleted" ],
            "example" : null
          },
          "archived_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Time at which the plan was moved to archived status.\n",
            "example" : null
          },
          "enabled_in_portal" : {
            "type" : "boolean",
            "default" : true,
            "deprecated" : false,
            "description" : "If enabled, customers can select this addon using the 'Change Subscription' option in the customer portal.\n",
            "example" : null
          },
          "tax_code" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The Avalara tax codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's [AvaTax for Sales integration](https://www.chargebee.com/docs/avalara.html)\n.\n",
            "maxLength" : 50,
            "example" : null
          },
          "hsn_code" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The [HSN code](https://cbic-gst.gov.in/gst-goods-services-rates.html)\nto which the item is mapped for calculating the customer's tax in India. Applicable only when both of the following conditions are true:\n\n* [**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.)\n* The [**AvaTax for Sales** integration](https://www.chargebee.com/docs/avalara.html) has been enabled in Chargebee.\n",
            "maxLength" : 50,
            "example" : null
          },
          "taxjar_product_code" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The TaxJar product codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's [TaxJar integration](https://www.chargebee.com/docs/taxjar.html)\n.\n",
            "maxLength" : 50,
            "example" : null
          },
          "avalara_sale_type" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Indicates the type of sale carried out. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)\nintegration.\n\n* retail - Transaction is a sale to an end user\n* vendor_use - Transaction is for an item that is subject to vendor use tax\n* wholesale - Transaction is a sale to another company that will resell your product or service to another consumer\n* consumed - Transaction is for an item that is consumed directly\n",
            "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)\nintegration.\n",
            "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)\nintegration.\n",
            "example" : null
          },
          "sku" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The field is used as Product name/code in your third party accounting application. Chargebee will use it as an alternate name in your accounting application.\n",
            "maxLength" : 100,
            "example" : null
          },
          "accounting_code" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "This field is to capture the Account code setup in your Accounting system for integration purposes only.\n",
            "maxLength" : 100,
            "example" : null
          },
          "accounting_category1" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/1.0/finance-integration-index.html )\n\n* [**Xero:**](https://www.chargebee.com/docs/1.0/xero.html ) If you've categorized your products in Xero, provide the category name and option. Use the format: `:` . For example:`Location: Singapore.`\n* [**QuickBooks:**](https://www.chargebee.com/docs/1.0/quickbooks.html ) If you've categorized your product sales in QuickBooks according to Classes, provide the class name here. Use the following format: `::...`\n* [**NetSuite:**](https://www.chargebee.com/docs/1.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.`\n* [**Intacct:**](https://www.chargebee.com/docs/1.0/intacct.html ) If you've classified your products in Intacct under Locations, provide the name of the Location here.\n",
            "maxLength" : 100,
            "example" : null
          },
          "accounting_category2" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/1.0/finance-integration-index.html )\n\n* [**Xero:**](https://www.chargebee.com/docs/1.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`\n* [**QuickBooks:**](https://www.chargebee.com/docs/1.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`\n* [**NetSuite:**](https://www.chargebee.com/docs/1.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`\n* [**Intacct:**](https://www.chargebee.com/docs/1.0/intacct.html ) If you've classified your products in Intacct under Dimensions, provide the value of the Dimension here.\n",
            "maxLength" : 100,
            "example" : null
          },
          "accounting_category3" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/1.0/finance-integration-index.html )\n\n* [**NetSuite:**](https://www.chargebee.com/docs/1.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.`\n* [**Intacct:**](https://www.chargebee.com/docs/1.0/intacct.html ) If you've classified your products in Intacct under multiple Dimensions, provide the value of the second Dimension here.\n",
            "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 )\n\n* [**NetSuite:**](https://www.chargebee.com/docs/1.0/netsuite.html ) Provide the \"Revenue Recognition Rule Id\" for the product from NetSuite.\n* [**Intacct:**](https://www.chargebee.com/docs/1.0/intacct.html ) If you have configured \"Revenue Recognition Templates\" for products in Intacct, provide the template ID for the product.\n",
            "maxLength" : 100,
            "example" : null
          },
          "is_shippable" : {
            "type" : "boolean",
            "default" : false,
            "deprecated" : false,
            "description" : "If enabled, charges for this plan/addon will be added to orders.\n",
            "example" : null
          },
          "shipping_frequency_period" : {
            "type" : "integer",
            "format" : "int32",
            "deprecated" : false,
            "description" : "Defines the shipping frequency. Example: to bill customer every 2 weeks, provide \"2\" here.\n",
            "minimum" : 1,
            "example" : null
          },
          "shipping_frequency_period_unit" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Defines the shipping frequency in association with shipping period.\n\n* day - Ship based on day(s)\n* week - Ship based on week(s)\n* month - Ship based on month(s)\n* year - Ship based on year(s)\n",
            "enum" : [ "year", "month", "week", "day" ],
            "example" : null
          },
          "resource_version" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Version number of this resource. The `resource_version`\nis 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.\n",
            "example" : null
          },
          "updated_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp indicating when this addon was last updated. This attribute will be present only if the resource has been updated after 2016-11-09.\n",
            "example" : null
          },
          "price_in_decimal" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The price of the addon when the `pricing_model`\nis `flat_fee`.\nWhen the pricing model is `per_unit`\n, 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/v2/pcv-1/currencies)\nis enabled.\n\nThis price is for the `period`\nof the addon. When attached to a plan, the addon is billed for the billing period of the plan. [Learn more](https://www.chargebee.com/docs/addons-billingcycle.html )\nis enabled.\n",
            "maxLength" : 39,
            "example" : null
          },
          "included_in_mrr" : {
            "type" : "boolean",
            "deprecated" : false,
            "description" : "The addon is included in MRR calculations for your site. This attribute is only applicable for addons of `charge_type = non_recurring`\nand when the feature is enabled in Chargebee. Note: If the site-level setting is to exclude non-recurring addons from MRR calculations, this value is always returned `false`\n.\n",
            "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) 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
          },
          "proration_type" : {
            "type" : "string",
            "default" : "site_default",
            "deprecated" : false,
            "description" : "**Note**\nApplicable only for addons with [pricing_model](/docs/api/v2/pcv-1/addons/addon-object#pricing_model) = `per_unit`.\n\nSpecifies how to manage charges or credits for the addon during a [subscription update](/docs/api/v2/pcv-1/subscriptions/update-a-subscription)\nor [estimating](/docs/api/v2/pcv-1/estimates/update-subscription-estimate)\na subscription update.\n\n* full_term - Charge the full price of the addon item price or give the full credit. Don't apply any proration.\n* site_default -\n  Use the [site-wide proration setting](https://www.chargebee.com/docs/1.0/proration.html#proration-for-subscription-change)\n  .\n* partial_term - Prorate the charges or credits for the rest of the current term.\n",
            "enum" : [ "site_default", "partial_term", "full_term" ],
            "example" : null
          },
          "invoice_notes" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "A customer-facing note added to all invoices associated with this API resource. This note becomes one among [all the notes](/docs/api/invoices/invoice-object#notes)\ndisplayed on the invoice PDF.\n",
            "maxLength" : 2000,
            "example" : null
          },
          "taxable" : {
            "type" : "boolean",
            "default" : true,
            "deprecated" : false,
            "description" : "Specifies whether taxes apply to this addon. This value is set and returned even if [Taxes](https://www.chargebee.com/docs/tax.html)\nhave been disabled in Chargebee. However, the value is effective only while Taxes are enabled.\n",
            "example" : null
          },
          "tax_profile_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Tax profile of the addon.\n",
            "maxLength" : 50,
            "example" : null
          },
          "meta_data" : {
            "type" : "object",
            "additionalProperties" : true,
            "deprecated" : false,
            "description" : "A collection of key-value pairs that provides extra information about the addon.  \n**Note:**\nThere's a character limit of 65,535.\n\n[Learn more](/docs/api/v2/pcv-1/advanced-features)\n.\n",
            "example" : null
          },
          "show_description_in_invoices" : {
            "type" : "boolean",
            "default" : false,
            "deprecated" : false,
            "description" : "Whether the [addon description](/docs/api/v2/pcv-1/addons/addon-object)\nshould be shown on [invoice PDFs](/docs/api/invoices/retrieve-invoice-as-pdf).\nIf 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)\n) after the change are affected; past invoices are not.\n",
            "example" : null
          },
          "show_description_in_quotes" : {
            "type" : "boolean",
            "default" : false,
            "deprecated" : false,
            "description" : "Whether the [addon description](/docs/api/v2/pcv-1/addons/addon-object)\nshould be shown on [quote PDFs](/docs/api/quotes/retrieve-quote-as-pdf).\nIf this Boolean is changed, only quotes created after the change are affected; past quotes are not.\n",
            "example" : null
          },
          "tiers" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "List of tiers for this addon(applicable only if it is tiered/volume/stairtstep pricing\n",
            "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\n",
                  "minimum" : 1,
                  "example" : null
                },
                "ending_unit" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "description" : "The upper limit of a range of units for the tier\n",
                  "example" : null
                },
                "price" : {
                  "type" : "integer",
                  "format" : "int64",
                  "default" : 0,
                  "deprecated" : false,
                  "description" : "The per-unit price for the tier when the `pricing_model`\nis `tiered`\nor `volume`\n; the total cost for the item price when the `pricing_model`\nis `stairstep`.\nThe value is in the [minor unit of the currency](/docs/api/v2/pcv-1/currencies)\n.\n",
                  "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`\nof the next lower tier. Returned only when the `pricing_model`\nis `tiered`\n, `volume`\nor `stairstep`\nand [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "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`\nof the next higher tier. Returned only when the `pricing_model`\nis `tiered`\n, `volume`\nor `stairstep`\nand [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "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`\nis `tiered`\nor `volume`.\nWhen the `pricing_model`\nis `stairstep`\n, 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/v2/pcv-1/currencies)\nis enabled.\n",
                  "maxLength" : 39,
                  "example" : null
                },
                "pricing_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "enum" : [ "per_unit", "flat_fee", "package" ],
                  "example" : null
                },
                "package_size" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "minimum" : 1,
                  "example" : null
                }
              },
              "required" : [ "price", "starting_unit" ],
              "example" : null
            },
            "example" : null
          },
          "tax_providers_fields" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "List of vendor specific tax related information.\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "provider_name" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Name of the tax provider currently we support.\n",
                  "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.\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "field_value" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The value of the corresponding tax field.\n",
                  "maxLength" : 50,
                  "example" : null
                }
              },
              "required" : [ "field_id", "field_value", "provider_name" ],
              "example" : null
            },
            "example" : null
          }
        },
        "required" : [ "charge_type", "currency_code", "enabled_in_portal", "id", "name", "period_unit", "pricing_model", "status" ],
        "example" : null
      },
      "AddonCreatedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "addon" : {
                "$ref" : "#/components/schemas/Addon"
              }
            },
            "required" : [ "addon" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "AddonDeletedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "addon" : {
                "$ref" : "#/components/schemas/Addon"
              }
            },
            "required" : [ "addon" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "AddonUpdatedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "addon" : {
                "$ref" : "#/components/schemas/Addon"
              }
            },
            "required" : [ "addon" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "Address" : {
        "type" : "object",
        "description" : "Subscriptions can have addresses like \"Shipping Address\" associated with them. This is apart from the billing address as part of credit card information.\n",
        "properties" : {
          "label" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Label to identify the address. This is unique for all the address for a subscription.\n",
            "maxLength" : 50,
            "example" : null
          },
          "first_name" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "First name\n",
            "maxLength" : 150,
            "example" : null
          },
          "last_name" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Last name\n",
            "maxLength" : 150,
            "example" : null
          },
          "email" : {
            "type" : "string",
            "format" : "email",
            "deprecated" : false,
            "description" : "Email\n",
            "maxLength" : 70,
            "example" : null
          },
          "company" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Company name\n",
            "maxLength" : 250,
            "example" : null
          },
          "phone" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Phone number\n",
            "maxLength" : 50,
            "example" : null
          },
          "addr" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Address line 1\n",
            "maxLength" : 150,
            "example" : null
          },
          "extended_addr" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Address line 2\n",
            "maxLength" : 150,
            "example" : null
          },
          "extended_addr2" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Address line 3\n",
            "maxLength" : 150,
            "example" : null
          },
          "city" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Name of the city\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
            "maxLength" : 50,
            "example" : null
          },
          "state" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "State or Province\n",
            "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)\n.\n",
            "maxLength" : 20,
            "example" : null
          },
          "validation_status" : {
            "type" : "string",
            "default" : "not_validated",
            "deprecated" : false,
            "description" : "The address verification status.\n\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* not_validated - Address is not yet validated.\n* invalid - Address is invalid.\n* valid - Address was validated successfully.\n",
            "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.\n",
            "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:\n\n* Set up a contract with your customers so that they can be notified of their payment schedules in advance.\n* Allow customers who make offline payments to be alerted about their upcoming dues well ahead of actual subscription renewals.\n* Prevent post-renewal unpaid usage of your services by customers.\n\nAdvance invoices can be scheduled in two ways:\n\n#### Specific Dates Schedule\n\nAdvance 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.\n\n#### Fixed Interval Schedule\n\nAdvance 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.\n\nThe 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.\n",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "System-generated and immutable unique Id for the `advance_invoice_schedule`\n.\n",
            "maxLength" : 40,
            "example" : null
          },
          "schedule_type" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The type of advance invoice or advance invoicing schedule.\n\n* specific_dates -\n  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)\n  is charged for. There can be up to 5 dates configured.\n* fixed_intervals -\n  The advance charges occur at [fixed intervals of time](/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#fixed_interval_schedule_terms_to_charge)\n  .\n",
            "enum" : [ "fixed_intervals", "specific_dates" ],
            "example" : null
          },
          "fixed_interval_schedule" : {
            "type" : "object",
            "deprecated" : false,
            "description" : "When the `schedule_type`\nis `fixed_intervals`\n, this object gives further details of the schedule.\n",
            "properties" : {
              "end_schedule_on" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Specifies when the schedule should end.\n\n* after_number_of_intervals - Advance invoices are generated a `specified number of times`\n* subscription_end - Advance invoices are generated for as long as the subscription is active.\n* specific_date -\n  End the advance invoicing schedule on a `specific date`\n  .\n",
                "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)\nof 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)\n= `after_number_of_intervals`\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",
                "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)\n= `specific_date`\n.\n",
                "example" : null
              },
              "created_at" : {
                "type" : "integer",
                "format" : "unix-time",
                "deprecated" : false,
                "description" : "The date when this advance invoicing schedule was created.\n",
                "example" : null
              },
              "terms_to_charge" : {
                "type" : "integer",
                "format" : "int32",
                "deprecated" : false,
                "description" : "The number of billing cycles in one interval.\n",
                "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)\nis charged for. There can be up to 5 dates configured.\n",
            "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)\nis specific_dates.\n",
                "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)\nis `specific_dates`\n.\n",
                "example" : null
              },
              "created_at" : {
                "type" : "integer",
                "format" : "unix-time",
                "deprecated" : false,
                "description" : "The date when this advance invoicing schedule was created.\n",
                "example" : null
              }
            },
            "required" : [ "created_at" ],
            "example" : null
          }
        },
        "required" : [ "id" ],
        "example" : null
      },
      "AlarmStatus" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "within_limit", "in_alarm" ],
        "example" : null
      },
      "Amendment" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 40,
            "example" : null
          },
          "subscription_id" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 50,
            "example" : null
          },
          "event_id" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 40,
            "example" : null
          },
          "type" : {
            "type" : "string",
            "deprecated" : false,
            "enum" : [ "subscription_changed", "subscription_created", "subscription_cancelled", "subscription_reactivated_with_backdating", "subscription_activated_with_backdating", "subscription_created_with_backdating", "subscription_resumption_scheduled", "subscription_scheduled_resumption_removed", "subscription_canceled_with_backdating", "subscription_changed_with_backdating", "subscription_changes_scheduled", "subscription_cancellation_scheduled", "subscription_pause_scheduled", "subscription_scheduled_changes_removed", "subscription_scheduled_cancellation_removed", "subscription_scheduled_pause_removed", "subscription_reactivated" ],
            "example" : null
          },
          "status" : {
            "type" : "string",
            "deprecated" : false,
            "enum" : [ "executed", "scheduled", "canceled" ],
            "example" : null
          },
          "sequence_number" : {
            "type" : "integer",
            "format" : "int32",
            "deprecated" : false,
            "minimum" : 1,
            "example" : null
          },
          "created_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "example" : null
          },
          "updated_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "example" : null
          },
          "effective_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "example" : null
          },
          "source" : {
            "type" : "string",
            "deprecated" : false,
            "enum" : [ "admin_console", "api", "scheduled_job", "hosted_page", "portal", "system", "none", "js_api", "migration", "bulk_operation", "external_service" ],
            "example" : null
          },
          "user" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 150,
            "example" : null
          },
          "api_key_name" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 150,
            "example" : null
          }
        },
        "required" : [ "created_at", "effective_at", "event_id", "id", "sequence_number", "source", "status", "subscription_id", "type" ],
        "example" : null
      },
      "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
      },
      "ApplyOn" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "invoice_amount", "specific_item_price" ],
        "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
      },
      "ApprovalEstimate" : {
        "type" : "object",
        "properties" : {
          "approval_required" : {
            "type" : "boolean",
            "deprecated" : false,
            "example" : null
          }
        },
        "required" : [ "approval_required" ],
        "example" : null
      },
      "AsyncJob" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 100,
            "example" : null
          },
          "status" : {
            "type" : "string",
            "deprecated" : false,
            "enum" : [ "in_progress", "completed", "failed" ],
            "example" : null
          },
          "created_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "example" : null
          },
          "completed_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "example" : null
          },
          "request" : {
            "type" : "object",
            "deprecated" : false,
            "properties" : {
              "resource" : {
                "type" : "string",
                "deprecated" : false,
                "maxLength" : 100,
                "example" : null
              },
              "action_type" : {
                "type" : "string",
                "deprecated" : false,
                "maxLength" : 100,
                "example" : null
              }
            },
            "required" : [ "action_type", "resource" ],
            "example" : null
          },
          "result" : {
            "type" : "object",
            "deprecated" : false,
            "properties" : {
              "content" : {
                "type" : "object",
                "additionalProperties" : true,
                "deprecated" : false,
                "example" : null
              },
              "content_list" : {
                "type" : "array",
                "deprecated" : false,
                "items" : {
                  "example" : null
                },
                "example" : null
              },
              "error" : {
                "type" : "object",
                "additionalProperties" : true,
                "deprecated" : false,
                "example" : null
              }
            },
            "example" : null
          }
        },
        "required" : [ "created_at", "id", "request", "status" ],
        "example" : null
      },
      "AsyncRequest" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 100,
            "example" : null
          },
          "resource" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 100,
            "example" : null
          },
          "operation_type" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 100,
            "example" : null
          },
          "status" : {
            "type" : "string",
            "deprecated" : false,
            "enum" : [ "enqueued", "in_process", "success", "failed" ],
            "example" : null
          },
          "created_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "example" : null
          },
          "started_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "example" : null
          },
          "completed_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "example" : null
          },
          "updated_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "example" : null
          },
          "result" : {
            "type" : "object",
            "additionalProperties" : true,
            "deprecated" : false,
            "example" : null
          },
          "error_detail" : {
            "type" : "object",
            "additionalProperties" : true,
            "deprecated" : false,
            "example" : null
          }
        },
        "required" : [ "created_at", "error_detail", "id", "operation_type", "resource", "result", "status", "updated_at" ],
        "example" : null
      },
      "AsyncResponse" : {
        "type" : "object",
        "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
          },
          "result" : {
            "type" : "object",
            "additionalProperties" : true,
            "deprecated" : false,
            "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
          }
        },
        "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
      },
      "AuthorizationSucceededEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "transaction" : {
                "$ref" : "#/components/schemas/Transaction"
              }
            },
            "required" : [ "transaction" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "AuthorizationVoidedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "transaction" : {
                "$ref" : "#/components/schemas/Transaction"
              }
            },
            "required" : [ "transaction" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "AutoCollection" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "on", "off" ],
        "example" : null
      },
      "AvalaraSaleType" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "wholesale", "retail", "consumed", "vendor_use" ],
        "example" : null
      },
      "BillingAlignmentMode" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "immediate", "delayed" ],
        "example" : null
      },
      "BillingConfiguration" : {
        "type" : "object",
        "properties" : {
          "is_calendar_billing_enabled" : {
            "type" : "boolean",
            "deprecated" : false,
            "example" : null
          },
          "billing_dates" : {
            "type" : "array",
            "deprecated" : false,
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "start_date" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "example" : null
                },
                "end_date" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "example" : null
                }
              },
              "example" : null
            },
            "example" : null
          }
        },
        "required" : [ "is_calendar_billing_enabled" ],
        "example" : null
      },
      "BillingDateMode" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "using_defaults", "manually_set" ],
        "example" : null
      },
      "BillingDayOfWeekMode" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "using_defaults", "manually_set" ],
        "example" : null
      },
      "BillingPeriodUnit" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "day", "week", "month", "year" ],
        "example" : null
      },
      "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\n",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The ID of the brand to which these offers belong.\n",
            "maxLength" : 50,
            "example" : null
          },
          "name" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The name of the brand to which these offers belong.\n",
            "maxLength" : 150,
            "example" : null
          }
        },
        "required" : [ "id", "name" ],
        "example" : null
      },
      "BrandConfiguration" : {
        "type" : "object",
        "properties" : {
          "logo_url" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 300,
            "example" : null
          },
          "scaled_logo_url" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 300,
            "example" : null
          },
          "scaled_logo_width" : {
            "type" : "integer",
            "format" : "int32",
            "deprecated" : false,
            "example" : null
          },
          "logo_size" : {
            "type" : "string",
            "deprecated" : false,
            "enum" : [ "small", "medium", "large" ],
            "example" : null
          },
          "icon_url" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 300,
            "example" : null
          },
          "scaled_icon_url" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 300,
            "example" : null
          },
          "scaled_icon_width" : {
            "type" : "integer",
            "format" : "int32",
            "deprecated" : false,
            "example" : null
          },
          "icon_size" : {
            "type" : "string",
            "deprecated" : false,
            "enum" : [ "small", "medium", "large" ],
            "example" : null
          },
          "favicon_url" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 300,
            "example" : null
          },
          "scaled_favicon_url" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 300,
            "example" : null
          },
          "color" : {
            "type" : "string",
            "default" : "#2196F3",
            "deprecated" : false,
            "maxLength" : 7,
            "example" : null
          },
          "modified_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "example" : null
          }
        },
        "required" : [ "modified_at" ],
        "example" : null
      },
      "BrandStyle" : {
        "type" : "object",
        "properties" : {
          "handle" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 100,
            "example" : null
          },
          "name" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 255,
            "example" : null
          },
          "custom_domain" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 255,
            "example" : null
          },
          "website_url" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 250,
            "example" : null
          },
          "created_by" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 255,
            "example" : null
          },
          "primary_color" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 50,
            "example" : null
          },
          "assets" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 65000,
            "example" : null
          },
          "configuration" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 65000,
            "example" : null
          }
        },
        "required" : [ "handle", "name" ],
        "example" : null
      },
      "CancelOption" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "immediately", "end_of_term", "specific_date", "end_of_billing_term" ],
        "example" : null
      },
      "Card" : {
        "type" : "object",
        "description" : "#### Deprecated\n\nThe [Payment Sources API](/docs/api/payment_sources)\n, with its additional options and improvements, obsoletes the Cards APIs. [Learn more](/docs/api/getting-started)\n.\n\nThe following table lists the Payment Sources API operations alongside the equivalent Card API operations:  \n\n|                             API at Card resource                             |                                                                                                                                         Use instead                                                                                                                                         |\n|------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Retrieve card for a customer](/docs/api/cards/retrieve-card-for-a-customer) | [Retrieve a payment source](/docs/api/payment_sources/retrieve-a-payment-source)                                                                                                                                                                                                            |\n| [Update card for a customer](/docs/api/cards/update-card-for-a-customer)     | * [Create using temporary token](/docs/api/v2/pcv-1/payment_sources/create-using-gateway-temporary-token) * [Create using permanent token](/docs/api/payment_sources/create-using-permanent-token) * [Create a card payment source](/docs/api/payment_sources/create-a-card-payment-source) |\n| [Switch gateway](/docs/api/cards/switch-gateway)                             | [Switch gateway account](/docs/api/payment_sources/switch-gateway-account)                                                                                                                                                                                                                  |\n| [Copy card](/docs/api/cards/copy-card)                                       | [Export payment source](/docs/api/payment_sources/export-payment-source)                                                                                                                                                                                                                    |\n| [Delete card for a customer](/docs/api/cards/delete-card-for-a-customer)     | [Delete a payment source](/docs/api/payment_sources/delete-a-payment-source)                                                                                                                                                                                                                |\n\n",
        "properties" : {
          "payment_source_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Identifier of the payment source\n",
            "maxLength" : 40,
            "example" : null
          },
          "status" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Current status of the card.\n\n* valid - A valid and active credit card\n* expiring - A card which is expiring in the current month.\n* expired - An expired card\n",
            "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 end-to-end 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.\n",
            "maxLength" : 50,
            "example" : null
          },
          "ref_tx_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Reference transaction id which used for transactions\n",
            "maxLength" : 50,
            "example" : null
          },
          "first_name" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Cardholder's first name\n",
            "maxLength" : 50,
            "example" : null
          },
          "last_name" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Cardholder's last name\n",
            "maxLength" : 50,
            "example" : null
          },
          "iin" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The Issuer Identification Number, i.e. the first six digits of the card number\n",
            "maxLength" : 6,
            "minLength" : 6,
            "example" : null
          },
          "last4" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Last four digits of the card number\n",
            "maxLength" : 4,
            "minLength" : 4,
            "example" : null
          },
          "card_type" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Card type\n\n* cabal - A Cabal card.\n* hipercard - An Hipercard.\n* dankort - A Dankort card.\n* bancontact - A Bancontact card.\n* american_express - An American Express card.\n* maestro - A Maestro card.\n* mada - A Mada card.\n* nativa - A Nativa card.\n* cmr_falabella - A CMR Falabella card.\n* not_applicable - Used for offline entries in transactions. Not applicable for cards\n* elo - A Elo card.\n* diners_club - A Diner's Club card.\n* discover - A Discover card.\n* other - Card belonging to types other than those listed above.\n* mastercard - A MasterCard.\n* jcb - A JCB card.\n* cartes_bancaires - A Cartes Bancaires card.\n* argencard - An Argencard.\n* cencosud - A Cencosud card.\n* tarjeta_naranja - A Tarjeta Naranja card.\n* visa - A Visa card.\n* carnet - A Carnet card.\n* rupay - A Rupay card.\n",
            "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\n\n* credit - A credit card.\n* prepaid - A prepaid card.\n* debit - A debit card.\n* not_applicable - Used for ACH. Not applicable for cards\n* not_known - An unknown card.\n",
            "enum" : [ "credit", "debit", "prepaid", "not_known", "not_applicable" ],
            "example" : null
          },
          "expiry_month" : {
            "type" : "integer",
            "format" : "int32",
            "deprecated" : false,
            "description" : "Card expiry month.\n",
            "maximum" : 12,
            "minimum" : 1,
            "example" : null
          },
          "expiry_year" : {
            "type" : "integer",
            "format" : "int32",
            "deprecated" : false,
            "description" : "Card expiry year.\n",
            "example" : null
          },
          "issuing_country" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "[two-letter(alpha2)](https://www.iso.org/iso-3166-country-codes.html)\nISO country code.\n",
            "maxLength" : 50,
            "example" : null
          },
          "billing_addr1" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Address line 1, as available in card billing address.\n",
            "maxLength" : 150,
            "example" : null
          },
          "billing_addr2" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Address line 2, as available in card billing address.\n",
            "maxLength" : 150,
            "example" : null
          },
          "billing_city" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "City, as available in card billing address.\n",
            "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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `billing_state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
            "maxLength" : 50,
            "example" : null
          },
          "billing_state" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The state/province name.\n",
            "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.\n",
            "maxLength" : 20,
            "example" : null
          },
          "created_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp indicating when this card resource is created.\n",
            "example" : null
          },
          "resource_version" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Version number of this resource. The `resource_version`\nis 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.\n",
            "example" : null
          },
          "updated_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp indicating when this credit card resource was last updated.\n",
            "example" : null
          },
          "ip_address" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The IP address of the customer. Used primarily for referral integration and EU VAT validation.\n",
            "maxLength" : 50,
            "example" : null
          },
          "powered_by" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Card powered by payment method.\n\n* card - card\n* ideal - ideal\n* payconiq - payconiq\n* sofort - sofort\n* bancontact - bancontact\n* giropay - giropay\n* latam_local_card - latam_local_card\n* not_applicable - not_applicable\n",
            "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.\n",
            "maxLength" : 50,
            "example" : null
          },
          "masked_number" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Masked credit card number that is safe to show.\n",
            "maxLength" : 19,
            "example" : null
          }
        },
        "required" : [ "created_at", "customer_id", "expiry_month", "expiry_year", "funding_type", "gateway", "iin", "last4", "payment_source_id", "status" ],
        "example" : null
      },
      "CardAddedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              }
            },
            "required" : [ "card", "customer" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "CardDeletedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              }
            },
            "required" : [ "card", "customer" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "CardExpiredEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              }
            },
            "required" : [ "card", "customer" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "CardExpiryReminderEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              }
            },
            "required" : [ "card", "customer" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "CardUpdatedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              }
            },
            "required" : [ "card", "customer" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "Category" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "introductory", "promotional", "developer_determined" ],
        "example" : null
      },
      "ChangeOption" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "immediately", "end_of_term", "specific_date" ],
        "example" : null
      },
      "Channel" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "web", "app_store", "play_store" ],
        "example" : null
      },
      "ChargeModel" : {
        "type" : "string",
        "deprecated" : true,
        "enum" : [ "full_charge", "prorate" ],
        "example" : null
      },
      "ChargeOn" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "immediately", "on_event" ],
        "example" : null
      },
      "ChargeOnEvent" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination", "on_demand" ],
        "example" : null
      },
      "ChargeOnOption" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "immediately", "on_event" ],
        "example" : null
      },
      "ChargebeeResponseSchemaType" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "plans_addons", "items", "compat" ],
        "example" : null
      },
      "ChargesHandling" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "invoice_immediately", "add_to_unbilled_charges" ],
        "example" : null
      },
      "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.\n\nWhen you make an API call on any resource eg., Subscriptions -\\> Change term end, you can add more context to that operation by calling the comments API as a follow up call.\n\nBesides 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.\n",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Unique identifier for the comment.\n",
            "maxLength" : 40,
            "example" : null
          },
          "entity_type" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Type of the entity this comment generated for\n\n* order - Entity that represents an order\n* customer - Entity that represents a customer\n* invoice - Invoice description\n* business_entity - Entity that represents item of type business entity\n* plan - Entity that represents a subscription plan\n* coupon - Entity that represents a discount coupon\n* subscription - Entity that represents a subscription of a customer\n* transaction - Entity that represents a transaction.\n* addon - Entity that represents an addon\n* credit_note - Credit note description\n* quote - Entity that represents a quote\n",
            "enum" : [ "customer", "subscription", "invoice", "quote", "credit_note", "transaction", "plan", "addon", "coupon", "order", "business_entity" ],
            "example" : null
          },
          "added_by" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The user who created the comment. If created via API, this contains the name given for the API key used.\n",
            "maxLength" : 100,
            "example" : null
          },
          "notes" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Actual notes for the comment.\n",
            "maxLength" : 1000,
            "example" : null
          },
          "created_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "The time at which this comment was created\n",
            "example" : null
          },
          "type" : {
            "type" : "string",
            "default" : "user",
            "deprecated" : false,
            "description" : "Type of comment this is.\n\n* user - Comment generated by user either via API or Admin console.\n* system - Comment generated by Chargebee when any backend changes happen for an entity\n",
            "enum" : [ "user", "system" ],
            "example" : null
          },
          "entity_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Unique identifier of the entity.\n",
            "maxLength" : 100,
            "example" : null
          },
          "business_entity_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity.\n\n**Note** [Multiple Business Entities](/docs/api/business_entities) is a feature available only on Product Catalog 2.0.\n",
            "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)\n(v1) and [Product Catalog 2.0](https://www.chargebee.com/docs/2.0/product-catalog.html)\n(v2).\n",
        "properties" : {
          "domain" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The Chargebee [site](https://www.chargebee.com/docs/2.0/sites-intro.html)\nfor which the information has been requested. It is the same as the value of `{site}`\nprovided as a path parameter.\n",
            "maxLength" : 50,
            "example" : null
          },
          "product_catalog_version" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The Product Catalog version of the site\n\n* v2 - Indicates Product Catalog 2.0\n* v1 - Indicates Product Catalog 1.0\n",
            "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.\n\n* 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.\n* items -\n  The response format follows [product catalog 2.0](https://www.chargebee.com/docs/billing/2.0/product-catalog/product-catalog)\n  , using [items](/docs/api/items)\n  .\n* plans_addons -\n  The response format follows [product catalog 1.0](https://www.chargebee.com/docs/billing/1.0/product-catalog/product-catalog)\n  , using [plans](/docs/api/v2/pcv-1/plans)\n  and [addons](/docs/api/v2/pcv-1/addons)\n  .\n",
            "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.\n",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Unique reference ID provided for the contact.\n",
            "maxLength" : 150,
            "example" : null
          },
          "first_name" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "First name of the contact.\n",
            "maxLength" : 150,
            "example" : null
          },
          "last_name" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Last name of the contact.\n",
            "maxLength" : 150,
            "example" : null
          },
          "email" : {
            "type" : "string",
            "format" : "email",
            "deprecated" : false,
            "description" : "Email of the contact.\n",
            "maxLength" : 70,
            "example" : null
          },
          "phone" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Phone number of the contact.\n",
            "maxLength" : 50,
            "example" : null
          },
          "label" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Label/Tag provided for contact.\n",
            "maxLength" : 50,
            "example" : null
          },
          "enabled" : {
            "type" : "boolean",
            "default" : false,
            "deprecated" : false,
            "description" : "Contact enabled / disabled\n",
            "example" : null
          },
          "send_account_email" : {
            "type" : "boolean",
            "default" : false,
            "deprecated" : false,
            "description" : "Whether Account Emails option is enabled for the contact.\n",
            "example" : null
          },
          "send_billing_email" : {
            "type" : "boolean",
            "default" : false,
            "deprecated" : false,
            "description" : "Whether Billing Emails option is enabled for the contact.\n",
            "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.\n\nThe **contract term** resource described below defines the properties of this lock-in period. This includes the [number of billing cycles](/docs/api/v2/pcv-1/contract_terms/contract_term-object#remaining_billing_cycles), the [total contract value](/docs/api/v2/pcv-1/contract_terms/contract_term-object#total_contract_value), the [action to be taken](/docs/api/v2/pcv-1/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/v2/pcv-1/contract_terms/contract_term-object#status) contract term and charging a [termination fee](/docs/api/v2/pcv-1/contract_terms).\n\nA 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/v2/pcv-1/subscriptions/subscription-object#contract_term) within the subscription.\n\nTo enable and configure contract terms, follow these steps in the Chargebee UI:\n\n1. Click **Settings** on the left navigation.\n2. Click **Configure Chargebee**.\n3. Under **Billing** , click **Contract Terms**.\n4. Enable and configure the feature as needed.\n\nOnce contract terms have been configured, the following actions can be performed using the API:\n\n* **Define a contract term** for a subscription and **set renewal options** for the contract term. The following endpoints support this:\n\n* [Create a subscription](/docs/api/v2/pcv-1/subscriptions/create-a-subscription)\n* [Create subscription for customer](/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer)\n* [Update a subscription](/docs/api/v2/pcv-1/subscriptions/update-a-subscription)\n* [Reactivate a subscription](/docs/api/v2/pcv-1/subscriptions/reactivate-a-subscription)\n* **Retrieving** a historical record of all contract terms for a subscription can be done via the following endpoint:\n\n* [List contract terms for a subscription](/docs/api/v2/pcv-1/subscriptions/list-contract-terms-for-a-subscription)\n* **Canceling a contract term** can be done via the following endpoints:\n\n* [Update a subscription](/docs/api/v2/pcv-1/subscriptions/update-a-subscription)\n* [Cancel a subscription](/docs/api/v2/pcv-1/subscriptions/cancel-a-subscription)\n\n#### Including a termination fee\n\nWhen a contract is canceled mid-term, you can set a termination fee to be levied. Here's how:\n\n1. [Create the termination fee as a `non_recurring` addon](/docs/api/v2/pcv-1/addons/create-an-addon#charge_type).\n2. [Associate this addon with a plan](/docs/api/v2/pcv-1/plans/plan-object#event_based_addons) or [include the addon to a subscription](/docs/api/v2/pcv-1/subscriptions/subscription-object#event_based_addons). In either case, set the `event_based_addons[on_event]` parameter to `contract_term_termination`.\n\nOnce 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/v2/pcv-1/subscriptions/cancel-a-subscription#contract_term_cancel_option).\n",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Id that uniquely identifies the contract term in the site.\n",
            "maxLength" : 50,
            "example" : null
          },
          "status" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Current status of contract\n\n* active - An actively running contract term.\n* cancelled -\n  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).\n\n  * the subscription was cancelled due to non-payment.\n* terminated - The contract term was terminated ahead of completion.\n* completed - The contract term has run its full duration.\n",
            "enum" : [ "active", "completed", "cancelled", "terminated" ],
            "example" : null
          },
          "contract_start" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "The start date of the contract term\n",
            "example" : null
          },
          "contract_end" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "The end date of the contract term\n",
            "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.\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.\n\n* renew -\n  * 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).\n  * The `action_at_term_end` for the new contract term is set to `renew`.\n* evergreen - Contract term completes and the subscription renews.\n* renew_once -\n  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).\n\n  * The `action_at_term_end` for the new contract term is set to `cancel`.\n* cancel - Contract term completes and subscription is canceled.\n",
            "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)\nof all the invoices raised as part of the contract term. For `active`\ncontract terms, this is a predicted value. The value depends on the [type of currency](/docs/api/v2/pcv-1/contract_terms).\nIf the subscription was [imported](/docs/api/v2/pcv-1/contract_terms)\nwith the contract term, then this value includes the value passed for `total_amount_raised`\n.\n",
            "minimum" : 0,
            "example" : null
          },
          "total_contract_value_before_tax" : {
            "type" : "integer",
            "format" : "int64",
            "default" : 0,
            "deprecated" : false,
            "minimum" : 0,
            "example" : null
          },
          "cancellation_cutoff_period" : {
            "type" : "integer",
            "format" : "int32",
            "deprecated" : false,
            "description" : "The number of days before [`contract_end`](/docs/api/contract_terms/contract_term-object#contract_end)\n, 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.\n",
            "example" : null
          },
          "created_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "The date when the contract term was created.\n",
            "example" : null
          },
          "subscription_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The [Id](/docs/api/subscriptions/subscription-object#id)\nof the subscription that this contract term is for.\n",
            "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`\ncontract terms.\n",
            "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\nOrder of application of coupons\n-------------------------------\n\nWhen multiple [coupons](/docs/api/coupons) are applied to a [subscription](/docs/api/subscriptions) or [one-time invoice](/docs/api/v2/pcv-1/invoices/create-an-invoice), 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, percentage coupons      | `coupon` with `apply_on` = `each_specified_item` and `discount_type` = `percentage` |\n| 3 | Invoice-level, fixed amount coupons | `coupon` with `apply_on` = `invoice_amount` and `discount_type` = `flat`            |\n| 4 | Invoice-level, percentage coupons   | `coupon` with `apply_on` = `invoice_amount` and `discount_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 coupon on the invoice\n* a 1% off coupon on the addon\n* a flat $10 coupon on the plan\n\nThe above coupons 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 | Flat $10 coupon on the plan                 | $(200 - 10) + $20 = $190 + $20 = $210      |\n| 3 | 1% off coupon on the addon                  | $190 + $(20 - 0.2) = $190 + $19.8 = $209.8 |\n| 4 | Flat $5 coupon on the invoice               | $209.8 - $5 = **$204.8**                   |\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.\n",
            "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/v2/pcv-1/coupons/coupon-object#discount_percentage).  \n  [Learn more](https://www.chargebee.com/docs/1.0/coupons.html#percentage)\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/v2/pcv-1/coupons/coupon-object#discount_amount).  \n  [Learn more](https://www.chargebee.com/docs/1.0/coupons.html#fixed-amount)\n  about `fixed_amount`\n  coupons.\n* offer_quantity -\n  A specified number of units of the plan or addon are offered for free. The number of free units is specified in [discount_quantity](/docs/api/v2/pcv-1/coupons/coupon-object#discount_quantity).\n  The `offer_quantity`\n  option is valid only when [apply_on](/docs/api/v2/pcv-1/coupons/coupon-object#apply_on)\n  is set to `each_specified_item`\n  and the `pricing_model`\n  of the [plan](/docs/api/v2/pcv-1/plans/plan-object#pricing_model)\n  or addon is `per_unit`.  \n  [Learn more](https://www.chargebee.com/docs/1.0/coupons.html#offer-quantity)\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.\n",
            "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)\n.\n",
            "minimum" : 0,
            "example" : null
          },
          "discount_quantity" : {
            "type" : "integer",
            "format" : "int32",
            "deprecated" : false,
            "description" : "Specifies the number of free units provided for the [plan](/docs/api/v2/pcv-1/plans)\nor [addon](/docs/api/v2/pcv-1/addons)\n, without affecting the total quantity sold. This parameter is applicable only when the [discount_type](/docs/api/v2/pcv-1/coupons/coupon-object#discount_type)\nis set to `offer_quantity`\n.\n",
            "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)\n) of the coupon. Applicable for *fixed_amount*\ncoupons alone.\n",
            "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.\n\n* forever - The coupon is attached to the subscription and applied on the invoices until explicitly removed.\n* one_time -\n  The coupon stays attached to the subscription till it is applied on an invoice **once**.\n  It is removed after that from the subscription.\n* limited_period -\n  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`\n  and `period_unit`\n  .\n",
            "enum" : [ "one_time", "forever", "limited_period" ],
            "example" : null
          },
          "valid_till" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Date upto which the coupon can be applied to new subscriptions.\n",
            "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.\n\n* expired -\n  Cannot be applied to a subscription. A coupon may expire due to exceeding [max_redemptions](/docs/api/coupons/coupon-object#max_redemptions)\n  or [valid_till](/docs/api/coupons/coupon-object#valid_till)\n  date is past. Existing associations remain unaffected.\n* archived - Cannot be applied to a subscription. Existing associations remain unaffected.\n* active - Can be applied to a subscription.\n* deleted - Indicates the coupon has been deleted.\n",
            "enum" : [ "active", "expired", "archived", "deleted" ],
            "example" : null
          },
          "apply_on" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The amount on the invoice to which the coupon is applied.\n\n* invoice_amount -\n  The coupon is applied to the invoice `sub_total`\n  .\n* each_specified_item -\n  The coupon is applied to the `invoice.line_item.amount`\n  that corresponds to the plan or addon specified by `plan_ids`\n  and `addon_ids`\n  .\n",
            "enum" : [ "invoice_amount", "each_specified_item" ],
            "example" : null
          },
          "plan_constraint" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Plans the coupon can be applied to.\n\n* specific - Coupon applicable to specific plan(s).\n* not_applicable - Coupon only applicable to invoice amount and not any plans.\n* none - Coupon not applicable to any plans.\n* all - Coupon applicable to all plans.\n",
            "enum" : [ "none", "all", "specific", "not_applicable" ],
            "example" : null
          },
          "addon_constraint" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Addons the coupon can be applied to.\n\n* none - Coupon not applicable to any addons.\n* not_applicable - Coupon only applicable to invoice amount and not any addons.\n* specific - Coupon applicable to specific addon(s).\n* all - Coupon applicable to all addons.\n",
            "enum" : [ "none", "all", "specific", "not_applicable" ],
            "example" : null
          },
          "created_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp indicating when this coupon is created.\n",
            "example" : null
          },
          "archived_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp indicating when this coupon was archived.\n",
            "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`\nis updated with a new timestamp in milliseconds.\n",
            "example" : null
          },
          "updated_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp indicating when this coupon was last updated.\nNote that this does not change when the [redemptions](/docs/api/coupons/coupon-object#redemptions)\nattribute is changed. This attribute will be present only if the resource has been updated after 2016-11-09.\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`\nand 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`\n.\n",
            "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`.\nApplicable only when [duration_type](/docs/api/coupons/coupon-object#duration_type)\nis [limited_period](/docs/api/coupons/coupon-object#duration_type)\n.\n",
            "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)\nis [limited_period](/docs/api/coupons/coupon-object#duration_type)\n.\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
          },
          "plan_ids" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "List of plan ids for which this coupon is applicable.\n",
            "items" : {
              "type" : "string",
              "deprecated" : false,
              "maxLength" : 100,
              "example" : null
            },
            "example" : null
          },
          "addon_ids" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "List of addon ids for which this coupon is applicable.\n",
            "items" : {
              "type" : "string",
              "deprecated" : false,
              "maxLength" : 100,
              "example" : null
            },
            "example" : null
          },
          "redemptions" : {
            "type" : "integer",
            "format" : "int32",
            "deprecated" : false,
            "description" : "The number of times this coupon has been redeemed.\n",
            "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)\ndisplayed on the invoice PDF.\n",
            "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/v2/pcv-1/advanced-features)\n.\n",
            "example" : null
          },
          "deleted" : {
            "type" : "boolean",
            "deprecated" : false,
            "description" : "Indicates whether the coupon is deleted or not.\n",
            "example" : null
          }
        },
        "required" : [ "addon_constraint", "apply_on", "created_at", "deleted", "discount_type", "duration_type", "id", "name", "plan_constraint" ],
        "example" : null
      },
      "CouponCode" : {
        "type" : "object",
        "description" : "Coupon codes are used along with existing coupons in Chargebee. You can create a coupon set using a bunch of coupon codes and this coupon set will be associated with an existing coupon. A coupon code can only be applied to a single subscription and cannot be re-used.\n\nUsing coupon codes you can distribute several unique codes for a single main coupon, when you are running promotions.\n",
        "properties" : {
          "code" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Unique coupon code that can be redeemed only once.\n",
            "maxLength" : 50,
            "example" : null
          },
          "status" : {
            "type" : "string",
            "default" : "not_redeemed",
            "deprecated" : false,
            "description" : "Status of the coupon code.\n\n* not_redeemed - Can be applied to a subscription.\n* redeemed - Cannot be applied to a subscription as the coupon code has been already used.\n* archived - Cannot be applied to a subscription as it has been made inactive.\n",
            "enum" : [ "not_redeemed", "redeemed", "archived" ],
            "example" : null
          },
          "coupon_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Id of the main coupon resource.\n",
            "maxLength" : 100,
            "example" : null
          },
          "coupon_set_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Uniquely identifies a coupon_set\n",
            "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.\n",
            "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.\n",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Uniquely identifies a coupon_set\n",
            "maxLength" : 50,
            "example" : null
          },
          "coupon_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Coupon id linked to coupon set\n",
            "maxLength" : 100,
            "example" : null
          },
          "name" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Name of the coupon set\n",
            "maxLength" : 50,
            "example" : null
          },
          "total_count" : {
            "type" : "integer",
            "format" : "int32",
            "deprecated" : false,
            "description" : "No of coupon codes present in coupon set\n",
            "example" : null
          },
          "redeemed_count" : {
            "type" : "integer",
            "format" : "int32",
            "deprecated" : false,
            "description" : "No of redeemed codes\n",
            "example" : null
          },
          "archived_count" : {
            "type" : "integer",
            "format" : "int32",
            "deprecated" : false,
            "description" : "No of archived codes\n",
            "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/v2/pcv-1/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/1.0/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/v2/pcv-1/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/v2/pcv-1/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/v2/pcv-1/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/v2/pcv-1/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/v2/pcv-1/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",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Credit-note id.\n",
            "maxLength" : 50,
            "example" : null
          },
          "customer_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The identifier of the customer this credit note belongs to.\n",
            "maxLength" : 50,
            "example" : null
          },
          "subscription_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The identifier of the subscription this credit note belongs to.\n**Note:**\nIf *consolidated invoicing*\nis 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)\n*subscription_id* .\nThis attribute should **not**\nbe used (which will be *null*\nif this credit note has lines from multiple subscriptions).\n",
            "maxLength" : 50,
            "example" : null
          },
          "reference_invoice_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The identifier of the invoice against which this Credit Note is issued\n",
            "maxLength" : 50,
            "example" : null
          },
          "type" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The credit note type. [Learn more](/docs/api/v2/pcv-1/credit_notes/credit-note-object)\nabout credit note types.\n\n* store - Store Credit Note\n* refundable - Refundable Credit Note\n* adjustment - Adjustment Credit Note\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)\nparameter instead\\]\n\n* subscription_change -\n  This reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html)\n  is enabled\n* order_change - Order Change\n* other - Can be set when none of the above reason codes are applicable\n* fraudulent - FRAUDULENT\n* chargeback - Can be set when you are recording your customer Chargebacks\n* subscription_pause - This reason will be automatically set to credit notes created during pause/resume subscription operation.\n* waiver - Waiver\n* subscription_cancellation - This reason will be set automatically for Credit Notes created during cancel subscription operation\n* product_unsatisfactory - Product Unsatisfactory\n* order_cancellation - Order Cancellation\n* write_off -\n  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)\n  operation.\n* service_unsatisfactory - Service Unsatisfactory\n",
            "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.\n\n* voided - When the Credit Note has been cancelled.\n* refund_due - When the credits are yet to be used, or have been partially used.\n* refunded - When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded).\n* adjusted - When the credit note has been adjusted against an invoice.\n",
            "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.\n",
            "maxLength" : 20,
            "example" : null
          },
          "date" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "The date the credit note is issued.\n",
            "example" : null
          },
          "price_type" : {
            "type" : "string",
            "default" : "tax_exclusive",
            "deprecated" : false,
            "description" : "The price type of the credit note.\n\n* tax_inclusive - All amounts in the document are inclusive of tax.\n* tax_exclusive - All amounts in the document are exclusive of tax.\n",
            "enum" : [ "tax_exclusive", "tax_inclusive" ],
            "example" : null
          },
          "currency_code" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The currency code (ISO 4217 format) for the credit note\n",
            "maxLength" : 3,
            "example" : null
          },
          "total" : {
            "type" : "integer",
            "format" : "int64",
            "default" : 0,
            "deprecated" : false,
            "description" : "Credit note amount in cents.\n",
            "minimum" : 0,
            "example" : null
          },
          "amount_allocated" : {
            "type" : "integer",
            "format" : "int64",
            "default" : 0,
            "deprecated" : false,
            "description" : "The amount allocated to invoices from the credit note.\n",
            "minimum" : 0,
            "example" : null
          },
          "amount_refunded" : {
            "type" : "integer",
            "format" : "int64",
            "default" : 0,
            "deprecated" : false,
            "description" : "The refunds issued from this credit note.\n",
            "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.\n",
            "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.\n",
            "example" : null
          },
          "voided_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp indicating the date and time this credit note gets voided.\n",
            "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.\n",
            "example" : null
          },
          "resource_version" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Version number of this resource. The `resource_version`\nis 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.\n",
            "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.\n",
            "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\n",
            "minimum" : 0,
            "example" : null
          },
          "sub_total_in_local_currency" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Credit note subtotal in the currency of the place of supply.\n",
            "minimum" : 0,
            "example" : null
          },
          "total_in_local_currency" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Total credit note amount in the currency of the place of supply.\n",
            "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.\n",
            "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`.\nIf there is no `round-off amount`\n, it will display `0`\n.\n",
            "maximum" : 99,
            "minimum" : -99,
            "example" : null
          },
          "fractional_correction" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Indicates the fractional correction amount.\n",
            "maximum" : 50000,
            "minimum" : -50000,
            "example" : null
          },
          "notes" : {
            "type" : "array",
            "deprecated" : false,
            "items" : {
              "type" : "string",
              "deprecated" : false,
              "maxLength" : 3500,
              "example" : null
            },
            "example" : null
          },
          "deleted" : {
            "type" : "boolean",
            "deprecated" : false,
            "description" : "Indicates that this resource has been deleted.\n",
            "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.\n",
            "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.\n\nFor 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.\n",
            "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**.\nMust be passed if set as mandatory in the app. The codes are case-sensitive\n",
            "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).\nOnly applicable specifically for customers with [billing_address](/docs/api/customers/customer-object#billing_address)\n\n`country`\nas `XI`\n(which is **United Kingdom - Northern Ireland**\n).\n\nWhen you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\nin 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\nthe Brexit configuration, you have the option of setting [billing_address](/docs/api/customers/customer-object#billing_address)\n\n`country`\nas `XI`.\nThat's the code for **United Kingdom - Northern Ireland** .\nThe first two characters of the VAT number in such a case is\n`XI`\nby default. However, if the VAT number was registered in UK, the value should be `GB`.\nSet\n`vat_number_prefix`\nto `GB`\nfor such cases.\n",
            "maxLength" : 10,
            "example" : null
          },
          "business_entity_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity.  \n**Note**\n\n[Multiple Business Entities](/docs/api/getting-started) is a feature available only on Product Catalog 2.0.\n",
            "maxLength" : 50,
            "example" : null
          },
          "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.\n",
            "maxLength" : 50,
            "example" : null
          },
          "line_items" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "The line items of this credit note\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Uniquely identifies a line_item\n",
                  "maxLength" : 40,
                  "example" : null
                },
                "subscription_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "A unique identifier for the subscription this line item belongs to.\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "date_from" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "Start date of this line item.\n",
                  "example" : null
                },
                "date_to" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "End date of this line item.\n",
                  "example" : null
                },
                "unit_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Unit amount of the line item.\n",
                  "example" : null
                },
                "quantity" : {
                  "type" : "integer",
                  "format" : "int32",
                  "default" : 1,
                  "deprecated" : false,
                  "description" : "[Quantity of the recurring item](/docs/api/v2/pcv-1/invoices/invoice-object#line_items_quantity)\nwhich is represented by this line item.\n",
                  "example" : null
                },
                "amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Total amount of this line item. Typically equals to unit amount x quantity\n",
                  "example" : null
                },
                "pricing_model" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The [pricing scheme](https://www.chargebee.com/docs/plans.html#pricing-attributes_pricing-model)\nfor this item.\n\n* stairstep - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.\n* flat_fee - A fixed price that is not quantity-based.\n* tiered - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.\n* per_unit - A fixed price per unit quantity.\n* volume - The per unit price is based on the tier that the total quantity falls in.\n",
                  "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\n",
                  "example" : null
                },
                "tax_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "default" : 0,
                  "deprecated" : false,
                  "description" : "The tax amount charged for this item\n",
                  "minimum" : 0,
                  "example" : null
                },
                "tax_rate" : {
                  "type" : "number",
                  "format" : "double",
                  "deprecated" : false,
                  "description" : "Rate of tax used to calculate tax for this lineitem\n",
                  "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`.\nThe value is in major units of the currency. Returned when the `line_item`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "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`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "maxLength" : 33,
                  "example" : null
                },
                "amount_in_decimal" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The decimal representation of the amount for the `line_item`\n, in major units of the currency. Typically equals to `unit_amount_in_decimal`\nx `quantity_in_decimal`.\nReturned when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "maxLength" : 39,
                  "example" : null
                },
                "discount_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Total discounts for this line\n",
                  "minimum" : 0,
                  "example" : null
                },
                "item_level_discount_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Line Item-level discounts for this line.\n",
                  "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.\n",
                  "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\n",
                  "maxLength" : 40,
                  "example" : null
                },
                "description" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Detailed description about this line item.\n",
                  "maxLength" : 250,
                  "example" : null
                },
                "entity_description" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Detailed description about this item.\n",
                  "maxLength" : 2000,
                  "example" : null
                },
                "entity_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Specifies the modelled entity this line item is based on.\n\n* addon -\n  Indicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the [addon](/docs/api/v2/pcv-1/addons/addon-object)\n  id\n* plan -\n  Indicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)\n  id\n* adhoc - Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case\n* plan_setup -\n  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)\n  id\n",
                  "enum" : [ "plan_setup", "plan", "addon", "adhoc" ],
                  "example" : null
                },
                "tax_exempt_reason" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The reason due to which the line item price/amount is exempted from tax.\n\n* 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.\n* reverse_charge - If the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU only\n* tax_not_configured - If tax is not enabled for the site\n* 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\n* tax_not_configured_external_provider - If the tax is not configured for the country in 3rd party tax provider.\n* customer_exempt - If the Customer is marked as Tax exempt\n* 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\n* product_exempt - If the Plan or Addon is marked as Tax exempt\n* zero_rated - If the rate of tax is 0% and no Sales/ GST tax is collectable for that line item\n* export -\n  You are not registered for tax in the customer's region. This is also the reason code when both `billing_address`\n  and `shipping_address`\n  have not been provided for the customer and subscription respectively\n",
                  "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\n",
                  "maxLength" : 100,
                  "example" : null
                },
                "customer_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "A unique identifier for the customer this line item belongs to\n",
                  "maxLength" : 100,
                  "example" : null
                },
                "proration_mode" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Proration mode for the line item.\n",
                  "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\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "line_item_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Uniquely identifies a line_item\n",
                  "maxLength" : 40,
                  "example" : null
                },
                "starting_unit" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "description" : "The lower limit of a range of units for the tier\n",
                  "minimum" : 0,
                  "example" : null
                },
                "ending_unit" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "description" : "The upper limit of a range of units for the tier\n",
                  "example" : null
                },
                "quantity_used" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "description" : "The number of units purchased in a range.\n",
                  "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`\npricing , or the price of each unit in the tier if the charge model is `tiered`\n/`volume`\npricing.\n",
                  "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`\nof the next lower tier. Returned only when the `line_items.pricing_model`\nis `tiered`\n, `volume`\nor `stairstep`\nand [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "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`\nof the next higher tier. Returned only when the `line_items.pricing_model`\nis `tiered`\n, `volume`\nor stairstep and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "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`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "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`\nis `tiered`\nor `volume`.\nWhen the `pricing_model`\nis `stairstep`\n, it is the decimal representation of the total price for `line_item`.\nThe value is in major units of the currency. Returned when the `line_item`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "maxLength" : 40,
                  "example" : null
                },
                "pricing_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "enum" : [ "per_unit", "flat_fee", "package" ],
                  "example" : null
                },
                "package_size" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "minimum" : 1,
                  "example" : null
                }
              },
              "required" : [ "quantity_used", "starting_unit", "unit_amount" ],
              "example" : null
            },
            "example" : null
          },
          "line_item_discounts" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "The list of discount(s) applied for each line item of this invoice.\n",
            "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.\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "discount_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The type of deduction and the amount to which it is applied.\n\n* prorated_credits -\n  The deduction is due to a legacy adjustment credit applied to the invoice. The `entity_id`\n  is `null`\n  in this case. The legacy credits feature is superseded by [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)\n  .\n* document_level_coupon -\n  The deduction is due to a coupon applied to the invoice `sub_total`.\n  The coupon `id`\n  is available as `entity_id`\n  .\n* promotional_credits -\n  The deduction is due to a [promotional credit](/docs/api/promotional_credits)\n  applied to the invoice. The `entity_id`\n  is `null`\n  in this case.\n* item_level_coupon -\n  The deduction is due to a coupon applied to a line item of the invoice. The coupon `id`\n  is available as `entity_id`\n  .\n",
                  "enum" : [ "item_level_coupon", "document_level_coupon", "promotional_credits", "prorated_credits" ],
                  "example" : null
                },
                "coupon_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "When the deduction is due to a coupon, then this is the id of the coupon.\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "entity_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 50,
                  "example" : null
                },
                "discount_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "The amount deducted. The format of this value depends on the [kind of currency](/docs/api/currencies)\n.\n",
                  "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\n",
            "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\n",
                  "maxLength" : 40,
                  "example" : null
                },
                "tax_name" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The name of the tax applied\n",
                  "maxLength" : 100,
                  "example" : null
                },
                "tax_rate" : {
                  "type" : "number",
                  "format" : "double",
                  "default" : 0,
                  "deprecated" : false,
                  "description" : "The rate of tax used to calculate tax amount\n",
                  "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.\n",
                  "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.\n",
                  "example" : null
                },
                "prorated_taxable_amount" : {
                  "type" : "number",
                  "format" : "decimal",
                  "deprecated" : false,
                  "description" : "Indicates the prorated line item amount in cents.\n",
                  "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.\n",
                  "example" : null
                },
                "is_non_compliance_tax" : {
                  "type" : "boolean",
                  "deprecated" : false,
                  "description" : "Indicates the non-compliance tax that should not be reported to the jurisdiction.\n",
                  "example" : null
                },
                "taxable_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Indicates the actual portion of the line item amount that is taxable.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "tax_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "The tax amount\n",
                  "minimum" : 0,
                  "example" : null
                },
                "tax_juris_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The type of tax jurisdiction\n\n* federal - The tax jurisdiction is a federal\n* state - The tax jurisdiction is a state\n* county - The tax jurisdiction is a county\n* country - The tax jurisdiction is a country\n* city - The tax jurisdiction is a city\n* special - Special tax jurisdiction.\n* unincorporated - Combined tax of state and county.\n* other - Jurisdictions other than the ones listed above.\n",
                  "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\n",
                  "maxLength" : 250,
                  "example" : null
                },
                "tax_juris_code" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The tax jurisdiction code\n",
                  "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.\n",
                  "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.\n",
                  "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.\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "line_item_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Line item reference\n",
                  "maxLength" : 40,
                  "example" : null
                },
                "first_name" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "First name of the customer\n",
                  "maxLength" : 150,
                  "example" : null
                },
                "last_name" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Last name of the customer\n",
                  "maxLength" : 150,
                  "example" : null
                },
                "email" : {
                  "type" : "string",
                  "format" : "email",
                  "deprecated" : false,
                  "description" : "Email address of the customer\n",
                  "maxLength" : 70,
                  "example" : null
                },
                "company" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Name of the company\n",
                  "maxLength" : 250,
                  "example" : null
                },
                "phone" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Phone number of the customer\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "line1" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Address line 1\n",
                  "maxLength" : 150,
                  "example" : null
                },
                "line2" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Address line 2\n",
                  "maxLength" : 150,
                  "example" : null
                },
                "line3" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Address line 3\n",
                  "maxLength" : 150,
                  "example" : null
                },
                "city" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Name of the city\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)\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n).\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "state" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "State or Province\n",
                  "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).\nEntering 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)\n.\n",
                  "maxLength" : 20,
                  "example" : null
                },
                "validation_status" : {
                  "type" : "string",
                  "default" : "not_validated",
                  "deprecated" : false,
                  "description" : "The address verification status.\n\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* valid - Address was validated successfully.\n",
                  "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\n",
            "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)\n.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "description" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Description for this deduction.\n",
                  "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]`\nis `item_level_coupon`\nor `document_level_coupon`\n.\n",
                  "maxLength" : 40,
                  "example" : null
                },
                "entity_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The type of deduction and the amount to which it is applied.\n\n* prorated_credits -\n  The deduction is due to a legacy adjustment credit applied to the invoice. The `entity_id`\n  is `null`\n  in this case. The legacy credits feature is superseded by [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)\n  .\n* item_level_coupon -\n  The deduction is due to a coupon applied to line item. The coupon `id`\n  is passed as `entity_id`\n  .\n* document_level_coupon -\n  The deduction is due to a coupon applied to the invoice `sub_total`.\n  The coupon id is passed as `entity_id`\n  .\n* promotional_credits -\n  The deduction is due to a [promotional credit](/docs/api/promotional_credits)\n  applied to the invoice.\n",
                  "enum" : [ "item_level_coupon", "document_level_coupon", "promotional_credits", "prorated_credits" ],
                  "example" : null
                },
                "discount_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "enum" : [ "fixed_amount", "percentage" ],
                  "example" : null
                },
                "entity_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "When the deduction is due to a `coupon`\n, then this is the `id`\nof the coupon.\n",
                  "maxLength" : 100,
                  "example" : null
                },
                "coupon_set_code" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The [coupon code](/docs/api/coupon_codes/coupon_code-object#code)\n, if applicable, used to provide the discount. The [coupon.id](/docs/api/coupons/coupon-object#id)\nis available in `entity_id`\n.\n",
                  "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\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "name" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The name of the tax applied. E.g. GST.\n",
                  "maxLength" : 100,
                  "example" : null
                },
                "amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "The tax amount.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "description" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Description of the tax item.\n",
                  "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.\n",
            "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)\n) where the tax originated from.\n",
                "maxLength" : 50,
                "example" : null
              },
              "registration_number" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "It represents the tax registration number for the entity used to collect tax.\n",
                "maxLength" : 100,
                "example" : null
              }
            },
            "example" : null
          },
          "linked_refunds" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "Payment Refunds issued from this credit note\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "txn_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Uniquely identifies the transaction.\n",
                  "maxLength" : 40,
                  "example" : null
                },
                "applied_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "The transaction amount applied to this invoice\n",
                  "minimum" : 0,
                  "example" : null
                },
                "applied_at" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "Time when the transaction amount applied to this invoice\n",
                  "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/v2/pcv-1/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/v2/pcv-1/transactions/transaction-object#status)\n  transaction to be reconciled at par with the gateway.  \n  [Learn more](https://www.chargebee.com/docs/payments/1.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.\n",
                  "example" : null
                },
                "txn_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Total amount of the transaction\n",
                  "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**.\nMust be passed if set as mandatory in the app. The codes are case-sensitive\n",
                  "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)\ncomponent of the `invoice`\n[associated](/docs/api/credit_notes/credit_note-object#reference_invoice_id)\nwith this `credit_note`.\n",
            "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_`.\nFor example, `tax_wh_16BdDXSlbu4uV1Ee6`\n.\n",
                  "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)\n.\n",
                  "minimum" : 1,
                  "example" : null
                },
                "description" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The description for this tax withheld.\n",
                  "maxLength" : 65000,
                  "example" : null
                },
                "date" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "Date or time associated with the tax withheld.\n",
                  "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.\n",
                  "maxLength" : 100,
                  "example" : null
                }
              },
              "required" : [ "id" ],
              "example" : null
            },
            "example" : null
          },
          "allocations" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "Invoice allocations made from this credit note.\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "invoice_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Unique identifier of the invoice.\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "allocated_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Amount of this refund transaction.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "allocated_at" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "Indicates when this refund occured.\n",
                  "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\n",
                  "example" : null
                },
                "invoice_status" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Current status of the invoice.\n\n* not_paid - Indicates the payment is not made and all attempts to collect is failed.\n* paid - Indicates a paid invoice.\n* voided - Indicates a voided 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* pending -\n  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`.\n  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.\n* payment_due - Indicates the payment is not yet collected and is being retried as per retry settings.\n",
                  "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.\n\n* pre_tax - Allocations are applied before tax calculation.\n* post_tax - Allocations are applied after tax calculation.\n",
                  "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,
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "currency_code" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 3,
                  "example" : null
                },
                "rate" : {
                  "type" : "number",
                  "format" : "decimal",
                  "deprecated" : false,
                  "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.\n",
            "properties" : {
              "first_name" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The first name of the contact.\n",
                "maxLength" : 150,
                "example" : null
              },
              "last_name" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The last name of the contact.\n",
                "maxLength" : 150,
                "example" : null
              },
              "email" : {
                "type" : "string",
                "format" : "email",
                "deprecated" : false,
                "description" : "The email address.\n",
                "maxLength" : 70,
                "example" : null
              },
              "company" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The company name.\n",
                "maxLength" : 250,
                "example" : null
              },
              "phone" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The phone number.\n",
                "maxLength" : 50,
                "example" : null
              },
              "line1" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Address line 1\n",
                "maxLength" : 150,
                "example" : null
              },
              "line2" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Address line 2\n",
                "maxLength" : 150,
                "example" : null
              },
              "line3" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Address line 3\n",
                "maxLength" : 150,
                "example" : null
              },
              "city" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n).\n",
                "maxLength" : 50,
                "example" : null
              },
              "state" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The state/province name.\n",
                "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)\n.\n",
                "maxLength" : 20,
                "example" : null
              },
              "validation_status" : {
                "type" : "string",
                "default" : "not_validated",
                "deprecated" : false,
                "description" : "The address verification status.\n\n* not_validated - Address is not yet validated.\n* valid - Address was validated successfully.\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n",
                "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                "example" : null
              }
            },
            "example" : null
          },
          "billing_address" : {
            "type" : "object",
            "deprecated" : false,
            "description" : "Billing address for the credit note.\n",
            "properties" : {
              "first_name" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The first name of the billing contact.\n",
                "maxLength" : 150,
                "example" : null
              },
              "last_name" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The last name of the billing contact.\n",
                "maxLength" : 150,
                "example" : null
              },
              "email" : {
                "type" : "string",
                "format" : "email",
                "deprecated" : false,
                "description" : "The email address.\n",
                "maxLength" : 70,
                "example" : null
              },
              "company" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The company name.\n",
                "maxLength" : 250,
                "example" : null
              },
              "phone" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The phone number.\n",
                "maxLength" : 50,
                "example" : null
              },
              "line1" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Address line 1\n",
                "maxLength" : 150,
                "example" : null
              },
              "line2" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Address line 2\n",
                "maxLength" : 150,
                "example" : null
              },
              "line3" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Address line 3\n",
                "maxLength" : 150,
                "example" : null
              },
              "city" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n).\n",
                "maxLength" : 50,
                "example" : null
              },
              "state" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "State or Province\n",
                "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)\n.\n",
                "maxLength" : 20,
                "example" : null
              },
              "validation_status" : {
                "type" : "string",
                "default" : "not_validated",
                "deprecated" : false,
                "description" : "The address verification status.\n\n* valid - Address was validated successfully.\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n",
                "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.\n",
            "properties" : {
              "id" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The unique `id`\nfor the e-invoice. This is auto-generated by Chargebee.\n",
                "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.\n",
                "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.\n\nIn the future, this field may be used to store similar reference numbers for other networks.\n",
                "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`\n, see `message`\n.\n\n* message_acknowledgement - An acknowledgment confirming that the application response was successfully received by the receiving entity.\n* under_query - The receiving entity has raised a query regarding the e-invoice. Additional information or clarification is required before proceeding.\n* 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.\n* scheduled - Sending the e-invoice to the customer has been scheduled.\n* paid - The receiving entity has confirmed that the e-invoice has been paid.\n* conditionally_accepted - The e-invoice has been accepted with conditions.\n* accepted - The e-invoice was sent and it was accepted by the receiving entity. The sending entity shall also accept the e-invoice.\n* skipped -\n  The e-invoice was not sent. This could be due to missing information or because the `entity_identifier`\n  is not registered on the e-invoicing network.\n* success - The e-invoice has been successfully delivered to the customer.\n* failed - The e-invoice was sent and there was an error due to which it was not delivered.\n* in_progress - The e-invoice has been sent and Chargebee is waiting for confirmation from the receiving entity.\n* in_process - The e-invoice is currently being processed by the receiving entity.\n* registered - The e-invoice was sent and there was an error due to which it was not delivered but got cleared in the IRP.\n",
                "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`\nis `skipped`\nor `failed`\n, this contains the reason or error details. The following are some valid examples:\n\n* Invoice successfully sent to customer via the e-invoicing network 9090:123456\n* Invoice successfully sent to customer via email id abc@acme.com\n",
                "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).\n",
                "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.\n",
            "properties" : {
              "timezone" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "It represents the timezone of the site at the time of entity creation.\n",
                "maxLength" : 50,
                "example" : null
              },
              "organization_address" : {
                "type" : "object",
                "additionalProperties" : true,
                "deprecated" : false,
                "description" : "It represents the address configured for the site during entity creation.\n",
                "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" : [ "plan_setup", "plan", "addon", "adhoc" ],
                  "example" : null
                },
                "tax_exempt_reason" : {
                  "type" : "string",
                  "deprecated" : false,
                  "enum" : [ "tax_not_configured", "region_non_taxable", "export", "customer_exempt", "product_exempt", "zero_rated", "reverse_charge", "high_value_physical_goods", "zero_value_item", "tax_not_configured_external_provider" ],
                  "example" : null
                },
                "entity_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 100,
                  "example" : null
                },
                "customer_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 100,
                  "example" : null
                },
                "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" ],
                  "example" : null
                },
                "coupon_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 50,
                  "example" : null
                },
                "entity_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 50,
                  "example" : null
                },
                "discount_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "minimum" : 0,
                  "example" : null
                }
              },
              "required" : [ "discount_amount", "discount_type", "line_item_id" ],
              "example" : null
            },
            "example" : null
          },
          "line_item_taxes" : {
            "type" : "array",
            "deprecated" : false,
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "line_item_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 40,
                  "example" : null
                },
                "tax_name" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 100,
                  "example" : null
                },
                "tax_rate" : {
                  "type" : "number",
                  "format" : "double",
                  "default" : 0,
                  "deprecated" : false,
                  "maximum" : 100,
                  "minimum" : 0,
                  "example" : null
                },
                "date_to" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "example" : null
                },
                "date_from" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "example" : null
                },
                "prorated_taxable_amount" : {
                  "type" : "number",
                  "format" : "decimal",
                  "deprecated" : false,
                  "maximum" : 1000000000,
                  "minimum" : -1000000000,
                  "example" : null
                },
                "is_partial_tax_applied" : {
                  "type" : "boolean",
                  "deprecated" : false,
                  "example" : null
                },
                "is_non_compliance_tax" : {
                  "type" : "boolean",
                  "deprecated" : false,
                  "example" : null
                },
                "taxable_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "minimum" : 0,
                  "example" : null
                },
                "tax_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "minimum" : 0,
                  "example" : null
                },
                "tax_juris_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "enum" : [ "country", "federal", "state", "county", "city", "special", "unincorporated", "other" ],
                  "example" : null
                },
                "tax_juris_name" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 250,
                  "example" : null
                },
                "tax_juris_code" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 250,
                  "example" : null
                },
                "tax_amount_in_local_currency" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "minimum" : 0,
                  "example" : null
                },
                "local_currency_code" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 3,
                  "example" : null
                }
              },
              "required" : [ "tax_amount", "tax_name", "tax_rate", "taxable_amount" ],
              "example" : null
            },
            "example" : null
          },
          "discounts" : {
            "type" : "array",
            "deprecated" : false,
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "minimum" : 0,
                  "example" : null
                },
                "description" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 250,
                  "example" : null
                },
                "line_item_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 40,
                  "example" : null
                },
                "entity_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "enum" : [ "item_level_coupon", "document_level_coupon", "promotional_credits", "prorated_credits" ],
                  "example" : null
                },
                "discount_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "enum" : [ "fixed_amount", "percentage" ],
                  "example" : null
                },
                "entity_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 100,
                  "example" : null
                },
                "coupon_set_code" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 50,
                  "example" : null
                }
              },
              "required" : [ "amount", "entity_type" ],
              "example" : null
            },
            "example" : null
          },
          "taxes" : {
            "type" : "array",
            "deprecated" : false,
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "name" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 100,
                  "example" : null
                },
                "amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "minimum" : 0,
                  "example" : null
                },
                "description" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 250,
                  "example" : null
                }
              },
              "required" : [ "amount", "name" ],
              "example" : null
            },
            "example" : null
          }
        },
        "required" : [ "amount_allocated", "amount_available", "currency_code", "price_type", "reference_invoice_id", "sub_total", "total", "type" ],
        "example" : null
      },
      "CreditNoteUpdatedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "credit_note" : {
                "$ref" : "#/components/schemas/CreditNote"
              }
            },
            "required" : [ "credit_note" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "CreditOptionForCurrentTermCharges" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "none", "prorate", "full", "consumption_based" ],
        "example" : null
      },
      "CreditType" : {
        "type" : "string",
        "default" : "general",
        "deprecated" : false,
        "enum" : [ "loyalty_credits", "referral_rewards", "general" ],
        "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/1.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/1.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/1.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/1.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/1.0/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/1.0/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/v2/pcv-1/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/v2/pcv-1/invoices/invoice-object#line_items_quantity)\nis 0.0765 and [unit_amount](/docs/api/v2/pcv-1/invoices/invoice-object#line_items_unit_amount)\nis $10.674, the line item [amount](/docs/api/v2/pcv-1/invoices/invoice-object#line_items_amount)\nis (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/1.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/v2/pcv-1/promotional_credits/add-promotional-credits)\n* [Deduct promotional credits from a customer](/docs/api/v2/pcv-1/promotional_credits/deduct-promotional-credits)\n* [Set promotional credits for a customer](/docs/api/v2/pcv-1/promotional_credits/set-promotional-credits)\n* [Record an excess payment for a customer](/docs/api/v2/pcv-1/customers/record-an-excess-payment-for-a-customer)\n* Invoice-related endpoints\n\n* [Create an invoice](/docs/api/v2/pcv-1/invoices/create-an-invoice)\n* Product catalog-related endpoints\n\n* [Create a plan](/docs/api/v2/pcv-1/plans/create-a-plan)\n* [Create an addon](/docs/api/v2/pcv-1/addons/create-an-addon)\n* [Create a coupon](/docs/api/v2/pcv-1/coupons/create-a-coupon)\n",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Unique identifier of a currency.\n",
            "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`\nthe foreign currency is archived else it is active\n",
            "example" : null
          },
          "forex_type" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "This represents the exchange rate type set for the currency.\n\n* auto -\n  If `forex_type`\n  is `auto`\n  , conversion rate will be auto updated by Chargebee every day with third party providers (using external currency conversion providers)\n* manual -\n  If `forex_type`\n  is `manual`\n  , 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\n",
            "enum" : [ "manual", "auto" ],
            "example" : null
          },
          "currency_code" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "A three letter currency code. For example, GBR, INR, and more.\n",
            "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`\nwhen the currency matches the site's base currency.\n",
            "example" : null
          },
          "manual_exchange_rate" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "This attribute shows the exchange rate in decimal. When `forex_type`\nis `manual`\nyou have to set the exchange rate for additional currencies in `manual_exchange_rate`\nfield.\n",
            "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", "plan_item", "addon_item", "charge_item", "plan_price", "addon_price", "charge_price", "differential_price", "attached_item", "feature", "subscription_entitlement", "item_entitlement", "business_entity", "omnichannel_subscription", "omnichannel_subscription_item", "omnichannel_transaction", "recorded_purchase", "omnichannel_subscription_item_scheduled_change", "sales_order", "omnichannel_one_time_order", "omnichannel_one_time_order_item", "usage_file", "business_rule", "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).\n",
        "properties" : {
          "entity_type" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Entity type that this configuration applies to.\n\n* item - Item entity.\n* invoice - Invoice entity.\n* subscription_entitlement - Subscription entitlement entity.\n* plan - Plan entity.\n* transaction - Transaction entity.\n* quote - Quote entity.\n* plan_price - Plan price entity.\n* customer - Customer entity.\n* differential_price - Differential price entity.\n* attached_item - Attached item entity.\n* coupon - Coupon entity.\n* subscription - Subscription entity.\n* addon - Addon entity.\n* addon_price - Addon price entity.\n* charge_item - Charge item entity.\n* feature - Feature entity.\n* item_entitlement - Item entitlement entity.\n* addon_item - Addon item entity.\n* charge_price - Charge price entity.\n* item_family - Item family entity.\n* plan_item - Plan item entity.\n* order - Order entity.\n* item_price - Item price entity.\n* business_entity - Business entity.\n* credit_note - Credit note entity.\n",
            "enum" : [ "customer", "subscription", "invoice", "quote", "credit_note", "transaction", "plan", "addon", "coupon", "order", "plan_item", "addon_item", "charge_item", "plan_price", "addon_price", "charge_price", "differential_price", "attached_item", "feature", "subscription_entitlement", "item_entitlement", "business_entity", "omnichannel_subscription", "omnichannel_subscription_item", "omnichannel_transaction", "recorded_purchase", "omnichannel_subscription_item_scheduled_change", "sales_order", "omnichannel_one_time_order", "omnichannel_one_time_order_item", "usage_file", "business_rule", "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.\n",
            "maxLength" : 50,
            "example" : null
          },
          "display_name" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Name of the field as it appears in the user interface.\n",
            "maxLength" : 50,
            "example" : null
          },
          "field_datatype" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Data type of the custom field value.\n\n* double - Double-precision number.\n* long - Integer (long).\n* timestamp - Timestamp value.\n* date - Date value.\n* email - Email address.\n* url - URL value.\n* string - String value.\n",
            "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.\n\n* radio_button_horizontal - Horizontal radio button group.\n* radio_button_vertical - Vertical radio button group.\n* text_area - Multi-line text input.\n* text - Single-line text input.\n* date_field - Date picker input.\n* date_time_field - Date and time picker input.\n* password - Password input (masked).\n* drop_down - Dropdown select input.\n* check_box - Check box input.\n* file - File upload input.\n",
            "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.\n",
            "maxLength" : 250,
            "example" : null
          },
          "required" : {
            "type" : "boolean",
            "default" : false,
            "deprecated" : false,
            "description" : "Whether the custom field is mandatory or optional.\n",
            "example" : null
          },
          "props" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "JSON object containing additional properties for the field (for example, options for a dropdown).\n",
            "maxLength" : 5000,
            "example" : null
          },
          "field_order" : {
            "type" : "integer",
            "format" : "int32",
            "deprecated" : false,
            "description" : "Display order of the field in the user interface.\n",
            "example" : null
          },
          "status" : {
            "type" : "string",
            "default" : "active",
            "deprecated" : false,
            "description" : "Whether the custom field configuration is active or archived.\n\n* archived - Only available in the index list page; soft deleted.\n* active - Visible and ready to use.\n",
            "enum" : [ "active", "archived" ],
            "example" : null
          },
          "published_status" : {
            "type" : "string",
            "default" : "new",
            "deprecated" : false,
            "description" : "Publishing status of the custom field configuration.\n\n* new - New configuration not yet published.\n* draft - Configuration is in draft and not yet published.\n* published - Configuration is published and in use.\n",
            "enum" : [ "new", "published", "draft" ],
            "example" : null
          },
          "created_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp when the custom field configuration was created.\n",
            "example" : null
          },
          "modified_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp when the custom field configuration was last updated.\n",
            "example" : null
          }
        },
        "required" : [ "api_name", "created_at", "display_name", "entity_type", "field_datatype", "modified_at", "props", "published_status", "required", "status" ],
        "example" : null
      },
      "Customer" : {
        "type" : "object",
        "additionalProperties" : true,
        "description" : "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/v2/pcv-1/subscriptions/subscription-object), [card information](/docs/api/v2/pcv-1/cards/card-object), and billing addresses. The customer details include their ID, name, contact information, and any custom attributes you'd like to associate with them.  \n**Breaking Change**:\n\n* [**Sites**](https://www.chargebee.com/docs/1.0/sites-intro.html)\\*\\* created before March 1, 2014\\*\\*: [updating the card](/docs/api/v2/pcv-1/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" : "Identifier of the customer.\n",
            "maxLength" : 50,
            "example" : null
          },
          "first_name" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "First name of the customer\n",
            "maxLength" : 150,
            "example" : null
          },
          "last_name" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Last name of the customer\n",
            "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.\n",
            "maxLength" : 70,
            "example" : null
          },
          "phone" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Phone number of the customer\n",
            "maxLength" : 50,
            "example" : null
          },
          "company" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Company name of the customer.\n",
            "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)\n\n`country`\nas\n`XI`\n(which is **United Kingdom - Northern Ireland**\n), the first two characters of the [full VAT number](https://en.wikipedia.org/wiki/VAT_identification_number)\ncan be overridden by setting\n[vat_number_prefix](/docs/api/customers/customer-object#vat_number_prefix)\n.\n",
            "maxLength" : 20,
            "example" : null
          },
          "auto_collection" : {
            "type" : "string",
            "default" : "on",
            "deprecated" : false,
            "description" : "Whether payments needs to be collected automatically for this customer\n\n* on - Whenever an invoice is created, an automatic attempt to charge the customer's payment method is made.\n* off - Automatic collection of charges will not be made. All payments must be recorded offline.\n",
            "enum" : [ "on", "off" ],
            "example" : null
          },
          "offline_payment_method" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The preferred offline payment method for the customer.\n\n* sepa_credit - SEPA Credit\n* cash - Cash\n* no_preference - No Preference\n* bank_transfer - Bank Transfer\n* check - Check\n* eu_automated_bank_transfer - EU Automated Bank Transfer\n* jp_automated_bank_transfer - JP Automated Bank Transfer\n* uk_automated_bank_transfer - UK Automated Bank Transfer\n* custom - Custom\n* boleto - Boleto\n* mx_automated_bank_transfer - MX Automated Bank Transfer\n* us_automated_bank_transfer - US Automated Bank Transfer\n* ach_credit - ACH Credit\n",
            "enum" : [ "no_preference", "cash", "check", "bank_transfer", "ach_credit", "sepa_credit", "boleto", "us_automated_bank_transfer", "eu_automated_bank_transfer", "uk_automated_bank_transfer", "jp_automated_bank_transfer", "mx_automated_bank_transfer", "custom" ],
            "example" : null
          },
          "net_term_days" : {
            "type" : "integer",
            "format" : "int32",
            "default" : 0,
            "deprecated" : false,
            "description" : "The number of days within which the customer has to make payment for the invoice.\n",
            "example" : null
          },
          "vat_number_validated_time" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Returns the recent VAT number validation time.\n",
            "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)\nis enabled.\n\n* 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.\n* 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.\n* valid - If the given VAT number is valid.\n* invalid - If the given VAT number is invalid.\n",
            "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\n",
            "example" : null
          },
          "is_location_valid" : {
            "type" : "boolean",
            "deprecated" : false,
            "description" : "Customer location is validated based on IP address and Card issuing country. If the location is valid, it returns True. If not, it returns False. Applicable only for EU, New Zealand and Australia.\n",
            "example" : null
          },
          "created_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp indicating when this customer resource is created.\n",
            "example" : null
          },
          "created_from_ip" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The IP address of the customer. Used primarily for [referral integrations](https://www.chargebee.com/docs/marketing-integration-index.html)\nand EU/UK VAT validation.\n",
            "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)\nintegration.\nTo 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/)\n.\n",
            "items" : {
              "example" : null
            },
            "example" : null
          },
          "taxability" : {
            "type" : "string",
            "default" : "taxable",
            "deprecated" : false,
            "description" : "Specifies if the customer is liable for tax\n\n* 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.\n* taxable -\n  Computes tax for the customer based on the [site configuration](https://www.chargebee.com/docs/tax.html).\n  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.\n* exempt -\n  * 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.\n  * 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.\n",
            "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)\n.\n\n* l - Other or custom\n* m - Educational organization\n* n - Local government\n* h - Commercial agricultural production\n* i - Industrial production/manufacturer\n* j - Direct pay permit\n* k - Direct mail\n* p - Commercial aquaculture\n* q - Commercial Fishery\n* r - Non-resident\n* d - Foreign diplomat\n* e - Charitable or benevolent organization\n* f - Religious organization\n* g - Resale\n* a - Federal government\n* b - State government\n* c - Tribe/Status Indian/Indian Band\n* med2 - US Medical Device Excise Tax with taxable sales tax\n* med1 - US Medical Device Excise Tax with exempt sales tax\n",
            "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)\n.\n",
            "maxLength" : 100,
            "example" : null
          },
          "resource_version" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Version number of this resource. The `resource_version`\nis 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.\n",
            "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.\n",
            "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.\n",
            "maxLength" : 50,
            "example" : null
          },
          "billing_date" : {
            "type" : "integer",
            "format" : "int32",
            "deprecated" : false,
            "description" : "Applicable when *calendar billing*\n(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.\n",
            "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*\nvalue is derived as per configurations or its specifically set (overriden). When specifically set, the *billing_date*\nwill not be reset even when all of the monthly/yearly subscriptions are cancelled.\n\n* manually_set - Billing date is specifically set (default configuration is overridden)\n* using_defaults - Billing date is set based on defaults configured.\n",
            "enum" : [ "using_defaults", "manually_set" ],
            "example" : null
          },
          "billing_day_of_week" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Applicable when *calendar billing*\n(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.\n\n* saturday - Saturday\n* monday - Monday\n* friday - Friday\n* sunday - Sunday\n* wednesday - Wednesday\n* thursday - Thursday\n* tuesday - Tuesday\n",
            "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*\nvalue is derived as per configurations or its specifically set (overriden). When specifically set, the *billing_day_of_week*\nwill not be reset even when all of the weekly subscriptions are cancelled.\n\n* using_defaults - Billing date is set based on defaults configured.\n* manually_set - Billing date is specifically set (default configuration is overridden)\n",
            "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\n\n* cleared - Cleared\n* scheduled_for_clear - Scheduled For Clear\n* active - Active\n",
            "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)\nfor 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)\nwhich takes precedence.\n",
            "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" : "This attribute is only valid for [product catalog 2.0](https://www.chargebee.com/docs/2.0/product-catalog.html)\nas the Multiple Business Entity features can only be enabled for product catalog 2.0.\n",
            "maxLength" : 50,
            "example" : null
          },
          "fraud_flag" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Indicates whether or not the customer has been identified as fraudulent.\n\n* suspicious - The customer has been identified as potentially fraudulent by the gateway\n* safe - The customer has been marked as safe\n* fraudulent - The customer has been marked as fraudulent\n",
            "enum" : [ "safe", "suspicious", "fraudulent" ],
            "example" : null
          },
          "primary_payment_source_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Primary payment source for the customer.\n",
            "maxLength" : 40,
            "example" : null
          },
          "backup_payment_source_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Backup payment source for the customer. Used to collect payment if primary payment source fails.\n",
            "maxLength" : 40,
            "example" : null
          },
          "invoice_notes" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "A customer-facing note added to all invoices associated with this API resource. This note becomes one among [all the notes](/docs/api/invoices/invoice-object#notes)\ndisplayed on the invoice PDF.\n",
            "maxLength" : 2000,
            "example" : null
          },
          "business_entity_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity.  \n**Note**\n\n[Multiple Business Entities](/docs/api/getting-started) is a feature available only on Product Catalog 2.0.\n",
            "maxLength" : 50,
            "example" : null
          },
          "preferred_currency_code" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The currency code of the customer's preferred currency (ISO 4217 format). Applicable if the Multicurrency feature is enabled.\n",
            "maxLength" : 3,
            "example" : null
          },
          "promotional_credits" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Promotional credits balance of this customer\n",
            "minimum" : 0,
            "example" : null
          },
          "unbilled_charges" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Total unbilled charges for this customer\n",
            "minimum" : 0,
            "example" : null
          },
          "refundable_credits" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Refundable credits balance of this customer\n",
            "minimum" : 0,
            "example" : null
          },
          "excess_payments" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Total unused payments associated with the customer\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 einvoice manually or automatic.\n\n* automatic - Use this value to send e-invoice every time an invoice or credit note is created.\n* manual - When manual is selected the automatic e-invoice sending is disabled. Use this value to send e-invoice manually through UI or API.\n* site_default - The default value of the site which can be overridden at the customer level.\n",
            "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/v2/pcv-1/advanced-features)\n.\n",
            "example" : null
          },
          "deleted" : {
            "type" : "boolean",
            "deprecated" : false,
            "description" : "Indicates that this resource has been deleted when the value is `true`\n.\n",
            "example" : null
          },
          "registered_for_gst" : {
            "type" : "boolean",
            "deprecated" : false,
            "description" : "Confirms that a customer is registered under GST. If set to `true`\nthen the [Reverse Charge Mechanism](https://www.chargebee.com/docs/australian-gst.html#reverse-charge-mechanism)\nis applicable. This field is applicable only when Australian GST is configured for your site.\n",
            "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" : "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)\nintegration.\n\n* industrial - When the purchase is made by an industrial business\n* residential - When the purchase is made by a customer for home use\n* 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\n* business - When the purchase is made at a place of business\n",
            "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.\n",
            "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)\nintegration.\n",
            "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.\nThe level of access is for data falling into two categories: - **Self-Serve Portal data:** subscriptions and invoices of the customer.\n\n* **Email Notifications:** subscription-, invoice- and payment-related notifications for the customer.\n",
            "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).\nOnly applicable specifically for customers with [billing_address](/docs/api/customers/customer-object#billing_address)\n\n`country`\nas `XI`\n(which is **United Kingdom - Northern Ireland**\n).\n\nWhen you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\nin 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\nthe Brexit configuration, you have the option of setting [billing_address](/docs/api/customers/customer-object#billing_address)\n\n`country`\nas `XI`.\nThat's the code for **United Kingdom - Northern Ireland** .\nThe first two characters of the VAT number in such a case is\n`XI`\nby default. However, if the VAT number was registered in UK, the value should be `GB`.\nSet\n`vat_number_prefix`\nto `GB`\nfor such cases.\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)\nof 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`.\nCurrently 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.\n",
            "maxLength" : 50,
            "example" : null
          },
          "billing_address" : {
            "type" : "object",
            "deprecated" : false,
            "description" : "Billing address for a customer.\n",
            "properties" : {
              "first_name" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The first name of the billing contact.\n",
                "maxLength" : 150,
                "example" : null
              },
              "last_name" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The last name of the billing contact.\n",
                "maxLength" : 150,
                "example" : null
              },
              "email" : {
                "type" : "string",
                "format" : "email",
                "deprecated" : false,
                "description" : "The email address.\n",
                "maxLength" : 70,
                "example" : null
              },
              "company" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The company name.\n",
                "maxLength" : 250,
                "example" : null
              },
              "phone" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The phone number.\n",
                "maxLength" : 50,
                "example" : null
              },
              "line1" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Address line 1\n",
                "maxLength" : 150,
                "example" : null
              },
              "line2" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Address line 2\n",
                "maxLength" : 150,
                "example" : null
              },
              "line3" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Address line 3\n",
                "maxLength" : 150,
                "example" : null
              },
              "city" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                "maxLength" : 50,
                "example" : null
              },
              "state" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "State or Province\n",
                "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)\n.\n",
                "maxLength" : 20,
                "example" : null
              },
              "validation_status" : {
                "type" : "string",
                "default" : "not_validated",
                "deprecated" : false,
                "description" : "The address verification status.\n\n* valid - Address was validated successfully.\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n",
                "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)\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "external_customer_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "External customer id in the referral system\n",
                  "maxLength" : 100,
                  "example" : null
                },
                "referral_sharing_url" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Referral sharing url for the customer\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "created_at" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "The referral url creation time\n",
                  "example" : null
                },
                "updated_at" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "The referral url updation time\n",
                  "example" : null
                },
                "referral_campaign_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Referral campaign id\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "referral_account_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Referral account id\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "referral_external_campaign_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Referral external campaign id\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "referral_system" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Url for the referral system account\n\n* referral_saasquatch - Referral Saasquatch\n* friendbuy - Friendbuy\n* referral_candy - Referral Candy\n",
                  "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\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Unique reference ID provided for the contact.\n",
                  "maxLength" : 150,
                  "example" : null
                },
                "first_name" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "First name of the contact.\n",
                  "maxLength" : 150,
                  "example" : null
                },
                "last_name" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Last name of the contact.\n",
                  "maxLength" : 150,
                  "example" : null
                },
                "email" : {
                  "type" : "string",
                  "format" : "email",
                  "deprecated" : false,
                  "description" : "Email of the contact.\n",
                  "maxLength" : 70,
                  "example" : null
                },
                "phone" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Phone number of the contact.\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "label" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Label/Tag provided for contact.\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "enabled" : {
                  "type" : "boolean",
                  "default" : false,
                  "deprecated" : false,
                  "description" : "Contact enabled / disabled\n",
                  "example" : null
                },
                "send_account_email" : {
                  "type" : "boolean",
                  "default" : false,
                  "deprecated" : false,
                  "description" : "Whether Account Emails option is enabled for the contact.\n",
                  "example" : null
                },
                "send_billing_email" : {
                  "type" : "boolean",
                  "default" : false,
                  "deprecated" : false,
                  "description" : "Whether Billing Emails option is enabled for the contact.\n",
                  "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.\n",
            "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 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 end-to-end 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.\n",
                "maxLength" : 50,
                "example" : null
              },
              "status" : {
                "type" : "string",
                "default" : "valid",
                "deprecated" : false,
                "description" : "Current status of the payment source.\n\n* expired - A payment source that has expired\n* invalid - The billing agreement cannot be used. It might become valid again either automatically or due to customer action.\n* valid - A payment source that is valid and active.\n* pending_verification - The payment source needs to be verified\n* expiring - A payment source that is expiring (like card's status based on its expiry date).\n",
                "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.\n**Note:**\nThis is not the one time temporary token provided by gateways like Stripe.\n",
                "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\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "promotional_credits" : {
                  "type" : "integer",
                  "format" : "int64",
                  "default" : 0,
                  "deprecated" : false,
                  "description" : "Promotional credits balance of this customer.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "excess_payments" : {
                  "type" : "integer",
                  "format" : "int64",
                  "default" : 0,
                  "deprecated" : false,
                  "description" : "Total unused payments associated with the customer.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "refundable_credits" : {
                  "type" : "integer",
                  "format" : "int64",
                  "default" : 0,
                  "deprecated" : false,
                  "description" : "Refundable credits balance of this customer\n",
                  "minimum" : 0,
                  "example" : null
                },
                "unbilled_charges" : {
                  "type" : "integer",
                  "format" : "int64",
                  "default" : 0,
                  "deprecated" : false,
                  "description" : "Total unbilled charges for this customer.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "currency_code" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The currency code (ISO 4217 format) for balance\n",
                  "maxLength" : 3,
                  "example" : null
                },
                "business_entity_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity.\n\n**Note** [Multiple Business Entities](/docs/api/business_entities) is a feature available only on Product Catalog 2.0.\n",
                  "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[]`\narray identifies a specific customer entity with the e-invoicing system. If the customer has only one entity identifier whose `value`\nis the `vat_number`\n, then this array is not needed as the `scheme`\ncan be provided via `entity_identifier_scheme`.\nThis array holds any additional entity identifiers that the customer may have.\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The unique id for the `entity_identifier`\nin Chargebee. When not provided, it is autogenerated.\n",
                  "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)\nof 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).\nIt includes the provider name, field Id, and its corresponding field value. It is used to send custom Tax provider fields to any tax provider.\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "provider_name" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Name of the tax vendor currently we support.\n",
                  "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.\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "field_value" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Field value of the corresponding tax field.\n",
                  "maxLength" : 50,
                  "example" : null
                }
              },
              "required" : [ "field_id", "field_value", "provider_name" ],
              "example" : null
            },
            "example" : null
          },
          "relationship" : {
            "type" : "object",
            "deprecated" : false,
            "description" : "The [account hierarchy](https://www.chargebee.com/docs/1.0/account-hierarchy.html)\nrelationship that the customer is part of.\n",
            "properties" : {
              "parent_id" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The `id`\nof the immediate parent of this customer under account hierarchy. If the customer is the root of the hierarchy, this attribute isn't returned.\n",
                "maxLength" : 50,
                "example" : null
              },
              "payment_owner_id" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The `id`\nof the customer responsible for paying the invoices for this customer. This ID must match either this customer's ID or the `invoice_owner_id`\n.\n",
                "maxLength" : 50,
                "example" : null
              },
              "invoice_owner_id" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The `id`\nof the customer who receives the invoice for charges incurred by the customer. This ID must match either this customer or one of its ancestors.\n",
                "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/1.0/account-hierarchy.html), this attribute defines the level of access that the parent account has to the customer's information.\n**Note:**\nthe 'parent' is the customer whose id is [payment_owner_id](/docs/api/v2/pcv-1/customers/customer-object#relationship_payment_owner_id).\nHowever, if the `payment_owner_id`\nis the customer itself, then the parent is [parent_id](/docs/api/v2/pcv-1/customers/customer-object#relationship_parent_id)\n.\n",
            "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.\n\n* no - The parent can't view or edit the child's subscriptions.\n* view_only - The parent can only view the child's subscriptions.\n* yes - The parent can view and edit the child's subscriptions.\n",
                "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.\n\n* no - The parent can't view or download the child's invoices.\n* yes - The parent can both view and download the child's invoices.\n* view_only - The parent can view but not download the child's invoices.\n",
                "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.\n",
                "example" : null
              },
              "send_invoice_emails" : {
                "type" : "boolean",
                "deprecated" : false,
                "description" : "Determines whether the parent receives email notifications for the child's invoices.\n",
                "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.\n",
                "example" : null
              }
            },
            "required" : [ "send_invoice_emails", "send_payment_emails", "send_subscription_emails" ],
            "example" : null
          },
          "child_account_access" : {
            "type" : "object",
            "deprecated" : false,
            "description" : "When the customer is part of an [account hierarchy](https://www.chargebee.com/docs/1.0/account-hierarchy.html)\n, this attribute defines the level of access that the customer has to its own information.\n",
            "properties" : {
              "portal_edit_subscriptions" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Determines the child's access to its own subscriptions in the Self-Serve Portal.\n\n* yes - The child account can view and edit its subscriptions.\n* view_only - The child account can only view its subscriptions.\n",
                "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.\n\n* view_only - The child account can view but not download its invoices.\n* yes - The child account can both view and download its invoices.\n* no - The child account cannot view or download its own invoices.\n",
                "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.\n",
                "example" : null
              },
              "send_invoice_emails" : {
                "type" : "boolean",
                "deprecated" : false,
                "description" : "Determines whether the child account receives email notifications for its invoices.\n",
                "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.\n",
                "example" : null
              }
            },
            "required" : [ "send_invoice_emails", "send_payment_emails", "send_subscription_emails" ],
            "example" : null
          }
        },
        "required" : [ "allow_direct_debit", "auto_collection", "created_at", "deleted", "excess_payments", "id", "net_term_days", "promotional_credits", "refundable_credits", "unbilled_charges" ],
        "example" : null
      },
      "CustomerChangedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              }
            },
            "required" : [ "card", "customer" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "CustomerCreatedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              }
            },
            "required" : [ "card", "customer" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "CustomerDeletedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              },
              "subscriptions" : {
                "type" : "array",
                "items" : {
                  "$ref" : "#/components/schemas/Subscription"
                },
                "example" : null
              }
            },
            "required" : [ "card", "customer", "subscriptions" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "CustomerMovedInEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              }
            },
            "required" : [ "card", "customer" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "CustomerMovedOutEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              }
            },
            "required" : [ "card", "customer" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "CustomerType" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "residential", "business", "senior_citizen", "industrial" ],
        "example" : null
      },
      "DedupeOption" : {
        "type" : "string",
        "deprecated" : true,
        "enum" : [ "skip", "update_existing" ],
        "example" : null
      },
      "DirectDebitScheme" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "ach", "bacs", "sepa_core", "autogiro", "becs", "becs_nz", "pad", "not_applicable" ],
        "example" : null
      },
      "DiscountType" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "fixed_amount", "percentage", "price" ],
        "example" : null
      },
      "DispositionType" : {
        "type" : "string",
        "default" : "attachment",
        "deprecated" : false,
        "enum" : [ "attachment", "inline" ],
        "example" : null
      },
      "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.\n",
        "properties" : {
          "download_url" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The URL at which the file is available for download.\n",
            "maxLength" : 3500,
            "example" : null
          },
          "valid_till" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "The time until which the `download_url`\nis valid.\n",
            "example" : null
          },
          "mime_type" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The [media type](https://en.wikipedia.org/wiki/Media_type)\nof the file.\n",
            "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
      },
      "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.\n",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The unique `id` for the e-invoice. This is auto-generated by Chargebee.\n",
            "maxLength" : 50,
            "example" : null
          },
          "entity_type" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The type of the parent document this e-invoice belongs to.\n\n* invoice - Invoice\n* credit_note - Credit note\n",
            "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.\n",
            "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.\n",
            "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.\n\nIn the future, this field may be used to store similar reference numbers for other networks.\n",
            "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`.\n\n* message_acknowledgement - An acknowledgment confirming that the application response was successfully received by the receiving entity.\n* in_progress - The e-invoice has been sent and Chargebee is waiting for confirmation from the receiving entity.\n* under_query - The receiving entity has raised a query regarding the e-invoice. Additional information or clarification is required before proceeding.\n* registered - The e-invoice was sent and there was an error due to which it was not delivered but got cleared in the IRP.\n* accepted - The e-invoice was sent and it was accepted by the receiving entity. The sending entity shall also accept the e-invoice.\n* success - The e-invoice has been successfully delivered to the customer.\n* 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.\n* in_process - The e-invoice is currently being processed by the receiving entity.\n* paid - The receiving entity has confirmed that the e-invoice has been paid.\n* 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.\n* failed - The e-invoice was sent and there was an error due to which it was not delivered.\n* scheduled - Sending the e-invoice to the customer has been scheduled.\n* conditionally_accepted - The e-invoice has been accepted with conditions.\n",
            "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:\n\n* Invoice successfully sent to customer via the e-invoicing network 9090:123456\n* Invoice successfully sent to customer via email id abc@acme.com\n",
            "maxLength" : 3000,
            "example" : null
          },
          "created_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp indicating when this e-invoice resource was created.\n",
            "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.\n",
            "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.\n",
            "example" : null
          },
          "deleted" : {
            "type" : "boolean",
            "deprecated" : false,
            "description" : "Indicates that this resource has been deleted.\n",
            "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).\n",
            "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.\n",
            "maxLength" : 50,
            "example" : null
          },
          "artifacts" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "List of e-invoice artifacts related to this e-invoice (for example application responses).\n",
            "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`.\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "direction" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Indicates whether the artifact was sent or received.\n\n* outbound - The artifact was generated by Chargebee and sent to an external e-invoicing provider/platform.\n* inbound - The artifact was received by Chargebee from an external e-invoicing provider/platform.\n",
                  "enum" : [ "outbound", "inbound" ],
                  "example" : null
                },
                "status" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Processing or business status of the artifact.\n\n* skipped - The artifact was not sent. This could be due to missing information.\n* scheduled - Sending the artifact has been scheduled.\n* registered - The artifact was sent and there was an error due to which it was not delivered but got cleared in the IRP.\n* success - The artifact has been successfully delivered.\n* failed - The artifact was sent and there was an error due to which it was not delivered.\n* in_progress - The artifact has been sent and Chargebee is waiting for confirmation from the receiving entity.\n",
                  "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.\n",
                  "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.\n",
                  "maxLength" : 100,
                  "example" : null
                },
                "created_at" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "Timestamp indicating when this artifact was created.\n",
                  "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.\n",
                  "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.\n",
                  "example" : null
                },
                "deleted" : {
                  "type" : "boolean",
                  "deprecated" : false,
                  "description" : "Indicates that this resource has been deleted.\n",
                  "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/v2/pcv-1/invoices#send_invoice_email), [send credit note email](/docs/api/v2/pcv-1/credit_notes#send_credit_note_email), and [send payment request email](/docs/api/v2/pcv-1/customers#send_payment_request_email).\n\nThese 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.\n",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Unique identifier of this email.\n",
            "maxLength" : 40,
            "example" : null
          },
          "template_name" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Name of the notification / email template that was sent.\n",
            "maxLength" : 100,
            "example" : null
          },
          "from_address" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The from email address used for this email.\n",
            "maxLength" : 254,
            "example" : null
          },
          "to_address" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The recipient email address.\n",
            "maxLength" : 254,
            "example" : null
          },
          "subject" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Subject line of the email.\n",
            "maxLength" : 500,
            "example" : null
          },
          "status" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Status of the email send request.\n\n* failed - Sending the email failed.\n* deferred - The email was deferred.\n* succeeded - The email was sent successfully.\n* scheduled - The email has been scheduled for delivery.\n",
            "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.\n",
            "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.\n",
            "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
      },
      "EntitlementVersion" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 100,
            "example" : null
          },
          "entity_id" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 100,
            "example" : null
          },
          "entity_type" : {
            "type" : "string",
            "deprecated" : false,
            "enum" : [ "plan", "addon", "charge", "plan_price", "addon_price" ],
            "example" : null
          },
          "feature_id" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 50,
            "example" : null
          },
          "feature_name" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 50,
            "example" : null
          },
          "value" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 50,
            "example" : null
          },
          "name" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 50,
            "example" : null
          },
          "change_reason" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 100,
            "example" : null
          },
          "created_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "example" : null
          },
          "modified_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "example" : null
          },
          "version" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "example" : null
          }
        },
        "required" : [ "id" ],
        "example" : null
      },
      "EntityCode" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "a", "b", "c", "d", "e", "f", "g", "h", "i", "j", "k", "l", "m", "n", "p", "q", "r", "med1", "med2" ],
        "example" : null
      },
      "EntityType" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "plan", "addon", "customer", "subscription", "coupon", "invoice", "quote", "credit_note", "transaction", "order", "plan_item", "addon_item", "charge_item", "plan_price", "addon_price", "charge_price", "differential_price", "attached_item", "feature", "subscription_entitlement", "item_entitlement", "business_entity", "omnichannel_subscription", "omnichannel_subscription_item", "omnichannel_transaction", "recorded_purchase", "omnichannel_subscription_item_scheduled_change", "sales_order", "omnichannel_one_time_order", "omnichannel_one_time_order_item", "usage_file", "business_rule", "business_ruleset", "alert_status", "omnichannel_subscription_item_metric", "price_ramp", "charge" ],
        "example" : null
      },
      "Estimate" : {
        "type" : "object",
        "description" : "During the process of signing up customers to subscriptions, use the Estimates API to evaluate the details of the purchase before actually signing them up. The details returned by the API include the invoice amounts, next billing date and unbilled charges.\n\nFor example, consider that you are creating a new subscription or update an existing one. Use the Estimates API before that to deduce the details such as the amount the customer would be charged, the state the subscription would be in after creation or updation, and so on.  \nIf you have configured the [Avalara integration](https://www.chargebee.com/docs/1.0/avalara.html), Chargebee retrieves the tax amount from Avalara for the invoice. This counts against your Avalara API limits.\n",
        "properties" : {
          "created_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "The time at which this estimate got generated\n",
            "example" : null
          },
          "subscription_estimate" : {
            "type" : "object",
            "deprecated" : false,
            "description" : "Represents the subscription details when the 'estimate' operations are invoked.\n",
            "properties" : {
              "id" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The identifier of the subscription\n",
                "maxLength" : 50,
                "example" : null
              },
              "currency_code" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The currency code (ISO 4217 format) of the subscription.\n",
                "maxLength" : 3,
                "example" : null
              },
              "status" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The status of the subscription.\n\n* in_trial - The subscription is in trial.\n* non_renewing - The subscription will be canceled at the end of the current term.\n* paused -\n  The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html).\n  The subscription will not renew while in this state.\n* transferred - The subscription has been transferred to another business entity within the organization.\n* future - The subscription is scheduled to start at a future date.\n* active - The subscription is active and will be charged for automatically based on the items in it.\n* cancelled - The subscription has been canceled and is no longer in service.\n",
                "enum" : [ "future", "in_trial", "active", "non_renewing", "paused", "cancelled", "transferred" ],
                "example" : null
              },
              "trial_end_action" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Applicable only when [End-of-trial Action](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)\nhas 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.\n\n* cancel_subscription - The subscription cancels.\n* site_default -\n  This is the default value. The action [configured for the site](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)\n  at the time when the trial ends, takes effect.\n* plan_default -\n  The action [configured for the site](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)\n  at the time when the trial ends, takes effect.\n* activate_subscription - The subscription activates and charges are raised for non-metered items.\n",
                "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.\n",
                "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\n",
                "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\n",
                "example" : null
              },
              "shipping_address" : {
                "type" : "object",
                "deprecated" : false,
                "description" : "Represents the shipping address when the 'estimate' operations are invoked.\n",
                "properties" : {
                  "first_name" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The first name of the contact.\n",
                    "maxLength" : 150,
                    "example" : null
                  },
                  "last_name" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The last name of the contact.\n",
                    "maxLength" : 150,
                    "example" : null
                  },
                  "email" : {
                    "type" : "string",
                    "format" : "email",
                    "deprecated" : false,
                    "description" : "The email address.\n",
                    "maxLength" : 70,
                    "example" : null
                  },
                  "company" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The company name.\n",
                    "maxLength" : 250,
                    "example" : null
                  },
                  "phone" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The phone number.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "line1" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Address line 1\n",
                    "maxLength" : 150,
                    "example" : null
                  },
                  "line2" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Address line 2\n",
                    "maxLength" : 150,
                    "example" : null
                  },
                  "line3" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Address line 3\n",
                    "maxLength" : 150,
                    "example" : null
                  },
                  "city" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n).\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "state" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The state/province name.\n",
                    "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)\n.\n",
                    "maxLength" : 20,
                    "example" : null
                  },
                  "validation_status" : {
                    "type" : "string",
                    "default" : "not_validated",
                    "deprecated" : false,
                    "description" : "The address verification status.\n\n* valid - Address was validated successfully.\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n",
                    "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.\n",
                "properties" : {
                  "id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Id that uniquely identifies the contract term in the site.\n",
                    "maxLength" : 50,
                    "example" : null
                  },
                  "status" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "Current status of contract\n\n* cancelled -\n  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).\n\n  * the subscription was cancelled due to non-payment.\n* terminated - The contract term was terminated ahead of completion.\n* active - An actively running contract term.\n* completed - The contract term has run its full duration.\n",
                    "enum" : [ "active", "completed", "cancelled", "terminated" ],
                    "example" : null
                  },
                  "contract_start" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "The start date of the contract term\n",
                    "example" : null
                  },
                  "contract_end" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "The end date of the contract term\n",
                    "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.\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.\n\n* evergreen - Contract term completes and the subscription renews.\n* renew_once -\n  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).\n\n  * The `action_at_term_end` for the new contract term is set to `cancel`.\n* renew -\n  * 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).\n  * 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", "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)\nof all the invoices raised as part of the contract term. For `active`\ncontract terms, this is a predicted value. The value depends on the [type of currency](/docs/api/v2/pcv-1/estimates).\nIf the subscription was [imported](/docs/api/v2/pcv-1/estimates)\nwith the contract term, then this value includes the value passed for `total_amount_raised`\n.\n",
                    "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`\nis included in the calculation of the total contract value before tax. It's important to note that this value excludes any applicable taxes.\n",
                    "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)\n, 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.\n",
                    "example" : null
                  },
                  "created_at" : {
                    "type" : "integer",
                    "format" : "unix-time",
                    "deprecated" : false,
                    "description" : "The date when the contract term was created.\n",
                    "example" : null
                  },
                  "subscription_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "The [Id](/docs/api/subscriptions/subscription-object#id)\nof the subscription that this contract term is for.\n",
                    "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`\ncontract terms.\n",
                    "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*\nobjects. It is generated when 'Create an estimate for purchase' operation is invoked\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The identifier of the subscription\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "currency_code" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The currency code (ISO 4217 format) of the subscription.\n",
                  "maxLength" : 3,
                  "example" : null
                },
                "status" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The status of the subscription.\n\n* future - The subscription is scheduled to start at a future date.\n* transferred - The subscription has been transferred to another business entity within the organization.\n* paused -\n  The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html).\n  The subscription will not renew while in this state.\n* in_trial - The subscription is in trial.\n* active - The subscription is active and will be charged for automatically based on the items in it.\n* non_renewing - The subscription will be canceled at the end of the current term.\n* cancelled - The subscription has been canceled and is no longer in service.\n",
                  "enum" : [ "future", "in_trial", "active", "non_renewing", "paused", "cancelled", "transferred" ],
                  "example" : null
                },
                "trial_end_action" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Applicable only when [End-of-trial Action](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)\nhas 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.\n\n* site_default -\n  The action [configured for the site](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)\n  at the time when the trial ends, takes effect. This is the default value when `trial_end_action`\n  is **not**\n  defined for the plan.\n* plan_default -\n  The action [configured for the site](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)\n  at the time when the trial ends, takes effect. This is the default value when `trial_end_action`\n  is defined for the plan.\n* cancel_subscription - The subscription cancels.\n* activate_subscription - The subscription activates and charges are raised for non-metered items.\n",
                  "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.\n",
                  "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\n",
                  "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\n",
                  "example" : null
                },
                "shipping_address" : {
                  "type" : "object",
                  "deprecated" : false,
                  "description" : "Represents the shipping address when the 'estimate' operations are invoked.\n",
                  "properties" : {
                    "first_name" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "The first name of the contact.\n",
                      "maxLength" : 150,
                      "example" : null
                    },
                    "last_name" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "The last name of the contact.\n",
                      "maxLength" : 150,
                      "example" : null
                    },
                    "email" : {
                      "type" : "string",
                      "format" : "email",
                      "deprecated" : false,
                      "description" : "The email address.\n",
                      "maxLength" : 70,
                      "example" : null
                    },
                    "company" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "The company name.\n",
                      "maxLength" : 250,
                      "example" : null
                    },
                    "phone" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "The phone number.\n",
                      "maxLength" : 50,
                      "example" : null
                    },
                    "line1" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "Address line 1\n",
                      "maxLength" : 150,
                      "example" : null
                    },
                    "line2" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "Address line 2\n",
                      "maxLength" : 150,
                      "example" : null
                    },
                    "line3" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "Address line 3\n",
                      "maxLength" : 150,
                      "example" : null
                    },
                    "city" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n).\n",
                      "maxLength" : 50,
                      "example" : null
                    },
                    "state" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "The state/province name.\n",
                      "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)\n.\n",
                      "maxLength" : 20,
                      "example" : null
                    },
                    "validation_status" : {
                      "type" : "string",
                      "default" : "not_validated",
                      "deprecated" : false,
                      "description" : "The address verification status.\n\n* valid - Address was validated successfully.\n* not_validated - Address is not yet validated.\n* invalid - Address is invalid.\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n",
                      "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.\n",
                  "properties" : {
                    "id" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "Id that uniquely identifies the contract term in the site.\n",
                      "maxLength" : 50,
                      "example" : null
                    },
                    "status" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "Current status of contract\n\n* completed - The contract term has run its full duration.\n* cancelled -\n  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).\n\n  * the subscription was cancelled due to non-payment.\n* active - An actively running contract term.\n* terminated - The contract term was terminated ahead of completion.\n",
                      "enum" : [ "active", "completed", "cancelled", "terminated" ],
                      "example" : null
                    },
                    "contract_start" : {
                      "type" : "integer",
                      "format" : "unix-time",
                      "deprecated" : false,
                      "description" : "The start date of the contract term\n",
                      "example" : null
                    },
                    "contract_end" : {
                      "type" : "integer",
                      "format" : "unix-time",
                      "deprecated" : false,
                      "description" : "The end date of the contract term\n",
                      "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.\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.\n\n* evergreen - Contract term completes and the subscription renews.\n* cancel - Contract term completes and subscription is canceled.\n* renew_once -\n  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).\n\n  * The `action_at_term_end` for the new contract term is set to `cancel`.\n* renew -\n  * 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).\n  * The `action_at_term_end` for the new contract term is set to `renew`.\n",
                      "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)\nof all the invoices raised as part of the contract term. For `active`\ncontract terms, this is a predicted value. The value depends on the [type of currency](/docs/api/v2/pcv-1/estimates).\nIf the subscription was [imported](/docs/api/v2/pcv-1/estimates)\nwith the contract term, then this value includes the value passed for `total_amount_raised`\n.\n",
                      "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`\nis included in the calculation of the total contract value before tax. It's important to note that this value excludes any applicable taxes.\n",
                      "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)\n, 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.\n",
                      "example" : null
                    },
                    "created_at" : {
                      "type" : "integer",
                      "format" : "unix-time",
                      "deprecated" : false,
                      "description" : "The date when the contract term was created.\n",
                      "example" : null
                    },
                    "subscription_id" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "The [Id](/docs/api/subscriptions/subscription-object#id)\nof the subscription that this contract term is for.\n",
                      "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`\ncontract terms.\n",
                      "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.\n",
            "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.\n",
                "example" : null
              },
              "price_type" : {
                "type" : "string",
                "default" : "tax_exclusive",
                "deprecated" : false,
                "description" : "The price type of this invoice.\n\n* tax_inclusive - All amounts in the document are inclusive of tax.\n* tax_exclusive - All amounts in the document are exclusive of tax.\n",
                "enum" : [ "tax_exclusive", "tax_inclusive" ],
                "example" : null
              },
              "currency_code" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The currency code (ISO 4217 format) of the invoice.\n",
                "maxLength" : 3,
                "example" : null
              },
              "sub_total" : {
                "type" : "integer",
                "format" : "int64",
                "deprecated" : false,
                "description" : "Invoice sub-total in cents.\n",
                "minimum" : 0,
                "example" : null
              },
              "total" : {
                "type" : "integer",
                "format" : "int64",
                "default" : 0,
                "deprecated" : false,
                "description" : "Invoice total in cents.\n",
                "minimum" : 0,
                "example" : null
              },
              "credits_applied" : {
                "type" : "integer",
                "format" : "int64",
                "default" : 0,
                "deprecated" : false,
                "description" : "credits applied to this invoice in cents.\n",
                "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.\n",
                "minimum" : 0,
                "example" : null
              },
              "amount_due" : {
                "type" : "integer",
                "format" : "int64",
                "default" : 0,
                "deprecated" : false,
                "description" : "Invoice amount due in cents\n",
                "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\n",
                      "maxLength" : 40,
                      "example" : null
                    },
                    "subscription_id" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "A unique identifier for the subscription this line item belongs to.\n",
                      "maxLength" : 50,
                      "example" : null
                    },
                    "date_from" : {
                      "type" : "integer",
                      "format" : "unix-time",
                      "deprecated" : false,
                      "description" : "Start date of this line item.\n",
                      "example" : null
                    },
                    "date_to" : {
                      "type" : "integer",
                      "format" : "unix-time",
                      "deprecated" : false,
                      "description" : "End date of this line item.\n",
                      "example" : null
                    },
                    "unit_amount" : {
                      "type" : "integer",
                      "format" : "int64",
                      "deprecated" : false,
                      "description" : "Unit amount of the line item.\n",
                      "example" : null
                    },
                    "quantity" : {
                      "type" : "integer",
                      "format" : "int32",
                      "default" : 1,
                      "deprecated" : false,
                      "description" : "[Quantity of the recurring item](/docs/api/v2/pcv-1/invoices/invoice-object#line_items_quantity)\nwhich is represented by this line item.\n",
                      "example" : null
                    },
                    "amount" : {
                      "type" : "integer",
                      "format" : "int64",
                      "deprecated" : false,
                      "description" : "Total amount of this line item. Typically equals to unit amount x quantity\n",
                      "example" : null
                    },
                    "pricing_model" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "The [pricing scheme](https://www.chargebee.com/docs/plans.html#pricing-attributes_pricing-model)\nfor this item.\n\n* tiered - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.\n* flat_fee - A fixed price that is not quantity-based.\n* volume - The per unit price is based on the tier that the total quantity falls in.\n* stairstep - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.\n* per_unit - A fixed price per unit quantity.\n",
                      "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\n",
                      "example" : null
                    },
                    "tax_amount" : {
                      "type" : "integer",
                      "format" : "int64",
                      "default" : 0,
                      "deprecated" : false,
                      "description" : "The tax amount charged for this item\n",
                      "minimum" : 0,
                      "example" : null
                    },
                    "tax_rate" : {
                      "type" : "number",
                      "format" : "double",
                      "deprecated" : false,
                      "description" : "Rate of tax used to calculate tax for this lineitem\n",
                      "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`.\nThe value is in major units of the currency. Returned when the `line_item`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                      "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`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                      "maxLength" : 33,
                      "example" : null
                    },
                    "amount_in_decimal" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "The decimal representation of the amount for the `line_item`\n, in major units of the currency. Typically equals to `unit_amount_in_decimal`\nx `quantity_in_decimal`.\nReturned when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                      "maxLength" : 39,
                      "example" : null
                    },
                    "discount_amount" : {
                      "type" : "integer",
                      "format" : "int64",
                      "deprecated" : false,
                      "description" : "Total discounts for this line\n",
                      "minimum" : 0,
                      "example" : null
                    },
                    "item_level_discount_amount" : {
                      "type" : "integer",
                      "format" : "int64",
                      "deprecated" : false,
                      "description" : "Line Item-level discounts for this line.\n",
                      "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.\n",
                      "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\n",
                      "maxLength" : 40,
                      "example" : null
                    },
                    "description" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "Detailed description about this line item.\n",
                      "maxLength" : 250,
                      "example" : null
                    },
                    "entity_description" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "Detailed description about this item.\n",
                      "maxLength" : 2000,
                      "example" : null
                    },
                    "entity_type" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "Specifies the modelled entity this line item is based on.\n\n* plan_setup -\n  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)\n  id\n* plan -\n  Indicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)\n  id\n* adhoc - Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case\n* addon -\n  Indicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the [addon](/docs/api/v2/pcv-1/addons/addon-object)\n  id\n",
                      "enum" : [ "plan_setup", "plan", "addon", "adhoc" ],
                      "example" : null
                    },
                    "tax_exempt_reason" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "The reason due to which the line item price/amount is exempted from tax.\n\n* 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.\n* 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\n* tax_not_configured - If tax is not enabled for the site\n* tax_not_configured_external_provider - If the tax is not configured for the country in 3rd party tax provider.\n* 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\n* reverse_charge - If the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU only\n* product_exempt - If the Plan or Addon is marked as Tax exempt\n* zero_rated - If the rate of tax is 0% and no Sales/ GST tax is collectable for that line item\n* export -\n  You are not registered for tax in the customer's region. This is also the reason code when both `billing_address`\n  and `shipping_address`\n  have not been provided for the customer and subscription respectively\n* customer_exempt - If the Customer is marked as Tax exempt\n",
                      "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\n",
                      "maxLength" : 100,
                      "example" : null
                    },
                    "customer_id" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "A unique identifier for the customer this line item belongs to\n",
                      "maxLength" : 100,
                      "example" : null
                    },
                    "proration_mode" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "Proration mode for the line item.\n",
                      "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\n",
                "items" : {
                  "type" : "object",
                  "deprecated" : false,
                  "properties" : {
                    "line_item_id" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "Uniquely identifies a line_item\n",
                      "maxLength" : 40,
                      "example" : null
                    },
                    "starting_unit" : {
                      "type" : "integer",
                      "format" : "int32",
                      "deprecated" : false,
                      "description" : "The lower limit of a range of units for the tier\n",
                      "minimum" : 0,
                      "example" : null
                    },
                    "ending_unit" : {
                      "type" : "integer",
                      "format" : "int32",
                      "deprecated" : false,
                      "description" : "The upper limit of a range of units for the tier\n",
                      "example" : null
                    },
                    "quantity_used" : {
                      "type" : "integer",
                      "format" : "int32",
                      "deprecated" : false,
                      "description" : "The number of units purchased in a range.\n",
                      "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`\npricing , or the price of each unit in the tier if the charge model is `tiered`\n/`volume`\npricing.\n",
                      "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`\nof the next lower tier. Returned only when the `line_items.pricing_model`\nis `tiered`\n, `volume`\nor `stairstep`\nand [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                      "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`\nof the next higher tier. Returned only when the `line_items.pricing_model`\nis `tiered`\n, `volume`\nor stairstep and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                      "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`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                      "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`\nis `tiered`\nor `volume`.\nWhen the `pricing_model`\nis `stairstep`\n, it is the decimal representation of the total price for `line_item`.\nThe value is in major units of the currency. Returned when the `line_item`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                      "maxLength" : 40,
                      "example" : null
                    },
                    "pricing_type" : {
                      "type" : "string",
                      "deprecated" : false,
                      "enum" : [ "per_unit", "flat_fee", "package" ],
                      "example" : null
                    },
                    "package_size" : {
                      "type" : "integer",
                      "format" : "int32",
                      "deprecated" : false,
                      "minimum" : 1,
                      "example" : null
                    }
                  },
                  "required" : [ "quantity_used", "starting_unit", "unit_amount" ],
                  "example" : null
                },
                "example" : null
              },
              "line_item_discounts" : {
                "type" : "array",
                "deprecated" : false,
                "description" : "The list of discount(s) applied for each line item of this invoice.\n",
                "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.\n",
                      "maxLength" : 50,
                      "example" : null
                    },
                    "discount_type" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "The type of deduction and the amount to which it is applied.\n\n* item_level_coupon -\n  The deduction is due to a coupon applied to a line item of the invoice. The coupon `id`\n  is available as `entity_id`\n  .\n* document_level_coupon -\n  The deduction is due to a coupon applied to the invoice `sub_total`.\n  The coupon `id`\n  is available as `entity_id`\n  .\n* prorated_credits -\n  The deduction is due to a legacy adjustment credit applied to the invoice. The `entity_id`\n  is `null`\n  in this case. The legacy credits feature is superseded by [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)\n  .\n* promotional_credits -\n  The deduction is due to a [promotional credit](/docs/api/promotional_credits)\n  applied to the invoice. The `entity_id`\n  is `null`\n  in this case.\n",
                      "enum" : [ "item_level_coupon", "document_level_coupon", "promotional_credits", "prorated_credits" ],
                      "example" : null
                    },
                    "coupon_id" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "When the deduction is due to a coupon, then this is the id of the coupon.\n",
                      "maxLength" : 50,
                      "example" : null
                    },
                    "entity_id" : {
                      "type" : "string",
                      "deprecated" : false,
                      "maxLength" : 50,
                      "example" : null
                    },
                    "discount_amount" : {
                      "type" : "integer",
                      "format" : "int64",
                      "deprecated" : false,
                      "description" : "The amount deducted. The format of this value depends on the [kind of currency](/docs/api/currencies)\n.\n",
                      "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\n",
                "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\n",
                      "maxLength" : 40,
                      "example" : null
                    },
                    "tax_name" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "The name of the tax applied\n",
                      "maxLength" : 100,
                      "example" : null
                    },
                    "tax_rate" : {
                      "type" : "number",
                      "format" : "double",
                      "default" : 0,
                      "deprecated" : false,
                      "description" : "The rate of tax used to calculate tax amount\n",
                      "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.\n",
                      "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.\n",
                      "example" : null
                    },
                    "prorated_taxable_amount" : {
                      "type" : "number",
                      "format" : "decimal",
                      "deprecated" : false,
                      "description" : "Indicates the prorated line item amount in cents\n",
                      "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.\n",
                      "example" : null
                    },
                    "is_non_compliance_tax" : {
                      "type" : "boolean",
                      "deprecated" : false,
                      "description" : "Indicates the non-compliance tax that should not be reported to the jurisdiction.\n",
                      "example" : null
                    },
                    "taxable_amount" : {
                      "type" : "integer",
                      "format" : "int64",
                      "deprecated" : false,
                      "description" : "Indicates the actual portion of the line item amount that is taxable.\n",
                      "minimum" : 0,
                      "example" : null
                    },
                    "tax_amount" : {
                      "type" : "integer",
                      "format" : "int64",
                      "deprecated" : false,
                      "description" : "The tax amount\n",
                      "minimum" : 0,
                      "example" : null
                    },
                    "tax_juris_type" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "The type of tax jurisdiction\n\n* special - Special tax jurisdiction.\n* unincorporated - Combined tax of state and county.\n* county - The tax jurisdiction is a county\n* city - The tax jurisdiction is a city\n* federal - The tax jurisdiction is a federal\n* country - The tax jurisdiction is a country\n* other - Jurisdictions other than the ones listed above.\n* state - The tax jurisdiction is a state\n",
                      "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\n",
                      "maxLength" : 250,
                      "example" : null
                    },
                    "tax_juris_code" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "The tax jurisdiction code\n",
                      "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.\n",
                      "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.\n",
                      "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.\n",
                "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.\n",
                      "maxLength" : 50,
                      "example" : null
                    },
                    "applied_amount" : {
                      "type" : "number",
                      "format" : "double",
                      "default" : 0,
                      "deprecated" : false,
                      "description" : "The credit amount is applied to the line item.\n",
                      "example" : null
                    },
                    "line_item_id" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "The unique ID of the line item to which this credit is applied.\n",
                      "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.\n",
                "items" : {
                  "type" : "object",
                  "deprecated" : false,
                  "properties" : {
                    "line_item_id" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "Line item reference\n",
                      "maxLength" : 40,
                      "example" : null
                    },
                    "first_name" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "First name of the customer\n",
                      "maxLength" : 150,
                      "example" : null
                    },
                    "last_name" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "Last name of the customer\n",
                      "maxLength" : 150,
                      "example" : null
                    },
                    "email" : {
                      "type" : "string",
                      "format" : "email",
                      "deprecated" : false,
                      "description" : "Email of the customer\n",
                      "maxLength" : 70,
                      "example" : null
                    },
                    "company" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "Name of the company\n",
                      "maxLength" : 250,
                      "example" : null
                    },
                    "phone" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "Phone number of the customer\n",
                      "maxLength" : 50,
                      "example" : null
                    },
                    "line1" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "Address line 1\n",
                      "maxLength" : 150,
                      "example" : null
                    },
                    "line2" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "Address line 2\n",
                      "maxLength" : 150,
                      "example" : null
                    },
                    "line3" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "Address line 3\n",
                      "maxLength" : 150,
                      "example" : null
                    },
                    "city" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "Name of the city\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)\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n).\n",
                      "maxLength" : 50,
                      "example" : null
                    },
                    "state" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "State or Province\n",
                      "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).\nEntering 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)\n.\n",
                      "maxLength" : 20,
                      "example" : null
                    },
                    "validation_status" : {
                      "type" : "string",
                      "default" : "not_validated",
                      "deprecated" : false,
                      "description" : "The address verification status.\n\n* not_validated - Address is not yet validated.\n* valid - Address was validated successfully.\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n",
                      "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\n",
                "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)\n.\n",
                      "minimum" : 0,
                      "example" : null
                    },
                    "description" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "Description for this deduction.\n",
                      "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]`\nis `item_level_coupon`\nor `document_level_coupon`\n.\n",
                      "maxLength" : 40,
                      "example" : null
                    },
                    "entity_type" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "The type of deduction and the amount to which it is applied.\n\n* item_level_coupon -\n  The deduction is due to a coupon applied to line item. The coupon `id`\n  is passed as `entity_id`\n  .\n* prorated_credits -\n  The deduction is due to a legacy adjustment credit applied to the invoice. The `entity_id`\n  is `null`\n  in this case. The legacy credits feature is superseded by [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)\n  .\n* document_level_coupon -\n  The deduction is due to a coupon applied to the invoice `sub_total`.\n  The coupon id is passed as `entity_id`\n  .\n* promotional_credits -\n  The deduction is due to a [promotional credit](/docs/api/promotional_credits)\n  applied to the invoice.\n",
                      "enum" : [ "item_level_coupon", "document_level_coupon", "promotional_credits", "prorated_credits" ],
                      "example" : null
                    },
                    "discount_type" : {
                      "type" : "string",
                      "deprecated" : false,
                      "enum" : [ "fixed_amount", "percentage" ],
                      "example" : null
                    },
                    "entity_id" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "When the deduction is due to a `coupon`\n, then this is the `id`\nof the coupon.\n",
                      "maxLength" : 100,
                      "example" : null
                    },
                    "coupon_set_code" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "The [coupon code](/docs/api/coupon_codes/coupon_code-object#code)\n, if applicable, used to provide the discount. The [coupon.id](/docs/api/coupons/coupon-object#id)\nis available in `entity_id`\n.\n",
                      "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\n",
                "items" : {
                  "type" : "object",
                  "deprecated" : false,
                  "properties" : {
                    "name" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "The name of the tax applied. E.g. GST.\n",
                      "maxLength" : 100,
                      "example" : null
                    },
                    "amount" : {
                      "type" : "integer",
                      "format" : "int64",
                      "deprecated" : false,
                      "description" : "The tax amount.\n",
                      "minimum" : 0,
                      "example" : null
                    },
                    "description" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "Description of the tax item.\n",
                      "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`.\nIf there is no `round-off amount`\n, it will display `0`\n.\n",
                "minimum" : 0,
                "example" : null
              },
              "customer_id" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "A unique identifier for the customer this invoice belongs to\n",
                "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*\nobjects. It is generated when 'Create an estimate for unbilled charges' operation is invoked\n",
            "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.\n",
                  "example" : null
                },
                "price_type" : {
                  "type" : "string",
                  "default" : "tax_exclusive",
                  "deprecated" : false,
                  "description" : "The price type of this invoice.\n\n* tax_inclusive - All amounts in the document are inclusive of tax.\n* tax_exclusive - All amounts in the document are exclusive of tax.\n",
                  "enum" : [ "tax_exclusive", "tax_inclusive" ],
                  "example" : null
                },
                "currency_code" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The currency code (ISO 4217 format) of the invoice.\n",
                  "maxLength" : 3,
                  "example" : null
                },
                "sub_total" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Invoice sub-total in cents.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "total" : {
                  "type" : "integer",
                  "format" : "int64",
                  "default" : 0,
                  "deprecated" : false,
                  "description" : "Invoice total in cents.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "credits_applied" : {
                  "type" : "integer",
                  "format" : "int64",
                  "default" : 0,
                  "deprecated" : false,
                  "description" : "credits applied to this invoice in cents.\n",
                  "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.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "amount_due" : {
                  "type" : "integer",
                  "format" : "int64",
                  "default" : 0,
                  "deprecated" : false,
                  "description" : "Invoice amount due in cents\n",
                  "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\n",
                        "maxLength" : 40,
                        "example" : null
                      },
                      "subscription_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "A unique identifier for the subscription this line item belongs to.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "date_from" : {
                        "type" : "integer",
                        "format" : "unix-time",
                        "deprecated" : false,
                        "description" : "Start date of this line item.\n",
                        "example" : null
                      },
                      "date_to" : {
                        "type" : "integer",
                        "format" : "unix-time",
                        "deprecated" : false,
                        "description" : "End date of this line item.\n",
                        "example" : null
                      },
                      "unit_amount" : {
                        "type" : "integer",
                        "format" : "int64",
                        "deprecated" : false,
                        "description" : "Unit amount of the line item.\n",
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "integer",
                        "format" : "int32",
                        "default" : 1,
                        "deprecated" : false,
                        "description" : "[Quantity of the recurring item](/docs/api/v2/pcv-1/invoices/invoice-object#line_items_quantity)\nwhich is represented by this line item.\n",
                        "example" : null
                      },
                      "amount" : {
                        "type" : "integer",
                        "format" : "int64",
                        "deprecated" : false,
                        "description" : "Total amount of this line item. Typically equals to unit amount x quantity\n",
                        "example" : null
                      },
                      "pricing_model" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The [pricing scheme](https://www.chargebee.com/docs/plans.html#pricing-attributes_pricing-model)\nfor this item.\n\n* tiered - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.\n* volume - The per unit price is based on the tier that the total quantity falls in.\n* per_unit - A fixed price per unit quantity.\n* flat_fee - A fixed price that is not quantity-based.\n* stairstep - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.\n",
                        "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\n",
                        "example" : null
                      },
                      "tax_amount" : {
                        "type" : "integer",
                        "format" : "int64",
                        "default" : 0,
                        "deprecated" : false,
                        "description" : "The tax amount charged for this item\n",
                        "minimum" : 0,
                        "example" : null
                      },
                      "tax_rate" : {
                        "type" : "number",
                        "format" : "double",
                        "deprecated" : false,
                        "description" : "Rate of tax used to calculate tax for this lineitem\n",
                        "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`.\nThe value is in major units of the currency. Returned when the `line_item`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "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`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "maxLength" : 33,
                        "example" : null
                      },
                      "amount_in_decimal" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The decimal representation of the amount for the `line_item`\n, in major units of the currency. Typically equals to `unit_amount_in_decimal`\nx `quantity_in_decimal`.\nReturned when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "maxLength" : 39,
                        "example" : null
                      },
                      "discount_amount" : {
                        "type" : "integer",
                        "format" : "int64",
                        "deprecated" : false,
                        "description" : "Total discounts for this line\n",
                        "minimum" : 0,
                        "example" : null
                      },
                      "item_level_discount_amount" : {
                        "type" : "integer",
                        "format" : "int64",
                        "deprecated" : false,
                        "description" : "Line Item-level discounts for this line.\n",
                        "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.\n",
                        "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\n",
                        "maxLength" : 40,
                        "example" : null
                      },
                      "description" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Detailed description about this line item.\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "entity_description" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Detailed description about this item.\n",
                        "maxLength" : 2000,
                        "example" : null
                      },
                      "entity_type" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Specifies the modelled entity this line item is based on.\n\n* plan_setup -\n  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)\n  id\n* addon -\n  Indicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the [addon](/docs/api/v2/pcv-1/addons/addon-object)\n  id\n* plan -\n  Indicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)\n  id\n* adhoc - Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case\n",
                        "enum" : [ "plan_setup", "plan", "addon", "adhoc" ],
                        "example" : null
                      },
                      "tax_exempt_reason" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The reason due to which the line item price/amount is exempted from tax.\n\n* tax_not_configured - If tax is not enabled for the site\n* tax_not_configured_external_provider - If the tax is not configured for the country in 3rd party tax provider.\n* export -\n  You are not registered for tax in the customer's region. This is also the reason code when both `billing_address`\n  and `shipping_address`\n  have not been provided for the customer and subscription respectively\n* customer_exempt - If the Customer is marked as Tax exempt\n* 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\n* reverse_charge - If the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU only\n* product_exempt - If the Plan or Addon is marked as Tax exempt\n* 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.\n* 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\n* zero_rated - If the rate of tax is 0% and no Sales/ GST tax is collectable for that line item\n",
                        "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\n",
                        "maxLength" : 100,
                        "example" : null
                      },
                      "customer_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "A unique identifier for the customer this line item belongs to\n",
                        "maxLength" : 100,
                        "example" : null
                      },
                      "proration_mode" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Proration mode for the line item.\n",
                        "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\n",
                  "items" : {
                    "type" : "object",
                    "deprecated" : false,
                    "properties" : {
                      "line_item_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Uniquely identifies a line_item\n",
                        "maxLength" : 40,
                        "example" : null
                      },
                      "starting_unit" : {
                        "type" : "integer",
                        "format" : "int32",
                        "deprecated" : false,
                        "description" : "The lower limit of a range of units for the tier\n",
                        "minimum" : 0,
                        "example" : null
                      },
                      "ending_unit" : {
                        "type" : "integer",
                        "format" : "int32",
                        "deprecated" : false,
                        "description" : "The upper limit of a range of units for the tier\n",
                        "example" : null
                      },
                      "quantity_used" : {
                        "type" : "integer",
                        "format" : "int32",
                        "deprecated" : false,
                        "description" : "The number of units purchased in a range.\n",
                        "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`\npricing , or the price of each unit in the tier if the charge model is `tiered`\n/`volume`\npricing.\n",
                        "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`\nof the next lower tier. Returned only when the `line_items.pricing_model`\nis `tiered`\n, `volume`\nor `stairstep`\nand [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "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`\nof the next higher tier. Returned only when the `line_items.pricing_model`\nis `tiered`\n, `volume`\nor stairstep and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "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`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "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`\nis `tiered`\nor `volume`.\nWhen the `pricing_model`\nis `stairstep`\n, it is the decimal representation of the total price for `line_item`.\nThe value is in major units of the currency. Returned when the `line_item`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "maxLength" : 40,
                        "example" : null
                      },
                      "pricing_type" : {
                        "type" : "string",
                        "deprecated" : false,
                        "enum" : [ "per_unit", "flat_fee", "package" ],
                        "example" : null
                      },
                      "package_size" : {
                        "type" : "integer",
                        "format" : "int32",
                        "deprecated" : false,
                        "minimum" : 1,
                        "example" : null
                      }
                    },
                    "required" : [ "quantity_used", "starting_unit", "unit_amount" ],
                    "example" : null
                  },
                  "example" : null
                },
                "line_item_discounts" : {
                  "type" : "array",
                  "deprecated" : false,
                  "description" : "The list of discount(s) applied for each line item of this invoice.\n",
                  "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.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "discount_type" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The type of deduction and the amount to which it is applied.\n\n* promotional_credits -\n  The deduction is due to a [promotional credit](/docs/api/promotional_credits)\n  applied to the invoice. The `entity_id`\n  is `null`\n  in this case.\n* item_level_coupon -\n  The deduction is due to a coupon applied to a line item of the invoice. The coupon `id`\n  is available as `entity_id`\n  .\n* document_level_coupon -\n  The deduction is due to a coupon applied to the invoice `sub_total`.\n  The coupon `id`\n  is available as `entity_id`\n  .\n* prorated_credits -\n  The deduction is due to a legacy adjustment credit applied to the invoice. The `entity_id`\n  is `null`\n  in this case. The legacy credits feature is superseded by [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)\n  .\n",
                        "enum" : [ "item_level_coupon", "document_level_coupon", "promotional_credits", "prorated_credits" ],
                        "example" : null
                      },
                      "coupon_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "When the deduction is due to a coupon, then this is the id of the coupon.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "entity_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "maxLength" : 50,
                        "example" : null
                      },
                      "discount_amount" : {
                        "type" : "integer",
                        "format" : "int64",
                        "deprecated" : false,
                        "description" : "The amount deducted. The format of this value depends on the [kind of currency](/docs/api/currencies)\n.\n",
                        "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\n",
                  "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\n",
                        "maxLength" : 40,
                        "example" : null
                      },
                      "tax_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the tax applied\n",
                        "maxLength" : 100,
                        "example" : null
                      },
                      "tax_rate" : {
                        "type" : "number",
                        "format" : "double",
                        "default" : 0,
                        "deprecated" : false,
                        "description" : "The rate of tax used to calculate tax amount\n",
                        "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.\n",
                        "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.\n",
                        "example" : null
                      },
                      "prorated_taxable_amount" : {
                        "type" : "number",
                        "format" : "decimal",
                        "deprecated" : false,
                        "description" : "Indicates the prorated line item amount in cents.\n",
                        "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.\n",
                        "example" : null
                      },
                      "is_non_compliance_tax" : {
                        "type" : "boolean",
                        "deprecated" : false,
                        "description" : "Indicates the non-compliance tax that should not be reported to the jurisdiction.\n",
                        "example" : null
                      },
                      "taxable_amount" : {
                        "type" : "integer",
                        "format" : "int64",
                        "deprecated" : false,
                        "description" : "Indicates the actual portion of the line item amount that is taxable.\n",
                        "minimum" : 0,
                        "example" : null
                      },
                      "tax_amount" : {
                        "type" : "integer",
                        "format" : "int64",
                        "deprecated" : false,
                        "description" : "The tax amount\n",
                        "minimum" : 0,
                        "example" : null
                      },
                      "tax_juris_type" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The type of tax jurisdiction\n\n* other - Jurisdictions other than the ones listed above.\n* federal - The tax jurisdiction is a federal\n* special - Special tax jurisdiction.\n* unincorporated - Combined tax of state and county.\n* country - The tax jurisdiction is a country\n* city - The tax jurisdiction is a city\n* county - The tax jurisdiction is a county\n* state - The tax jurisdiction is a state\n",
                        "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\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "tax_juris_code" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The tax jurisdiction code\n",
                        "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.\n",
                        "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.\n",
                        "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.\n",
                  "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.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "applied_amount" : {
                        "type" : "number",
                        "format" : "double",
                        "default" : 0,
                        "deprecated" : false,
                        "description" : "The credit amount is applied to the line item.\n",
                        "example" : null
                      },
                      "line_item_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The unique ID of the line item to which this credit is applied.\n",
                        "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.\n",
                  "items" : {
                    "type" : "object",
                    "deprecated" : false,
                    "properties" : {
                      "line_item_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Line item reference\n",
                        "maxLength" : 40,
                        "example" : null
                      },
                      "first_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "First name of the customer\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "last_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Last name of the customer\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "email" : {
                        "type" : "string",
                        "format" : "email",
                        "deprecated" : false,
                        "description" : "Email of the customer\n",
                        "maxLength" : 70,
                        "example" : null
                      },
                      "company" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Name of the company\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "phone" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Phone number of the customer\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "line1" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 1\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line2" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 2\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "line3" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Address line 3\n",
                        "maxLength" : 150,
                        "example" : null
                      },
                      "city" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Name of the city\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)\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n).\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "state" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "State or Province\n",
                        "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).\nEntering 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)\n.\n",
                        "maxLength" : 20,
                        "example" : null
                      },
                      "validation_status" : {
                        "type" : "string",
                        "default" : "not_validated",
                        "deprecated" : false,
                        "description" : "The address verification status.\n\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* valid - Address was validated successfully.\n",
                        "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\n",
                  "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)\n.\n",
                        "minimum" : 0,
                        "example" : null
                      },
                      "description" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Description for this deduction.\n",
                        "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]`\nis `item_level_coupon`\nor `document_level_coupon`\n.\n",
                        "maxLength" : 40,
                        "example" : null
                      },
                      "entity_type" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The type of deduction and the amount to which it is applied.\n\n* prorated_credits -\n  The deduction is due to a legacy adjustment credit applied to the invoice. The `entity_id`\n  is `null`\n  in this case. The legacy credits feature is superseded by [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)\n  .\n* promotional_credits -\n  The deduction is due to a [promotional credit](/docs/api/promotional_credits)\n  applied to the invoice.\n* item_level_coupon -\n  The deduction is due to a coupon applied to line item. The coupon `id`\n  is passed as `entity_id`\n  .\n* document_level_coupon -\n  The deduction is due to a coupon applied to the invoice `sub_total`.\n  The coupon id is passed as `entity_id`\n  .\n",
                        "enum" : [ "item_level_coupon", "document_level_coupon", "promotional_credits", "prorated_credits" ],
                        "example" : null
                      },
                      "discount_type" : {
                        "type" : "string",
                        "deprecated" : false,
                        "enum" : [ "fixed_amount", "percentage" ],
                        "example" : null
                      },
                      "entity_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "When the deduction is due to a `coupon`\n, then this is the `id`\nof the coupon.\n",
                        "maxLength" : 100,
                        "example" : null
                      },
                      "coupon_set_code" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The [coupon code](/docs/api/coupon_codes/coupon_code-object#code)\n, if applicable, used to provide the discount. The [coupon.id](/docs/api/coupons/coupon-object#id)\nis available in `entity_id`\n.\n",
                        "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\n",
                  "items" : {
                    "type" : "object",
                    "deprecated" : false,
                    "properties" : {
                      "name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the tax applied. E.g. GST.\n",
                        "maxLength" : 100,
                        "example" : null
                      },
                      "amount" : {
                        "type" : "integer",
                        "format" : "int64",
                        "deprecated" : false,
                        "description" : "The tax amount.\n",
                        "minimum" : 0,
                        "example" : null
                      },
                      "description" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Description of the tax item.\n",
                        "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`.\nIf there is no `round-off amount`\n, it will display `0`\n.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "customer_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "A unique identifier for the customer this invoice belongs to\n",
                  "maxLength" : 100,
                  "example" : null
                }
              },
              "required" : [ "currency_code", "price_type", "recurring", "sub_total" ],
              "example" : null
            },
            "example" : null
          },
          "payment_schedule_estimates" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "payment_schedule_estimate resource is used to hold the details related to payment schedules for an invoice. It will contain list of payment_schedules resource.\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "An auto-generated unique identifier for the payment schedules.\n",
                  "maxLength" : 40,
                  "example" : null
                },
                "scheme_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The identifier of the `payment_schedule_scheme`\n, used to create the payment schedules.\n",
                  "maxLength" : 40,
                  "example" : null
                },
                "entity_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Specifies the modelled entity this payment schedule is based on\n\n* invoice - invoice\n",
                  "enum" : [ "invoice" ],
                  "example" : null
                },
                "entity_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The identifier of the modelled entity this payment schedule is based on.\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "total maximum amount that this payment schedule is allowed to collect\n",
                  "minimum" : 0,
                  "example" : null
                },
                "currency_code" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The currency code (ISO 4217 format) of the transaction amount.\n",
                  "maxLength" : 3,
                  "example" : null
                },
                "schedule_entries" : {
                  "type" : "array",
                  "deprecated" : false,
                  "description" : "List of schedule entries\n",
                  "items" : {
                    "type" : "object",
                    "deprecated" : false,
                    "properties" : {
                      "id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "An auto-generated unique identifier for the payment schedules.\n",
                        "maxLength" : 40,
                        "example" : null
                      },
                      "date" : {
                        "type" : "integer",
                        "format" : "unix-time",
                        "deprecated" : false,
                        "description" : "date at which this payment schedule is scheduled\n",
                        "example" : null
                      },
                      "amount" : {
                        "type" : "integer",
                        "format" : "int64",
                        "deprecated" : false,
                        "description" : "total maximum amount that this payment schedule is allowed to collect\n",
                        "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`.\n",
                        "minimum" : 0,
                        "example" : null
                      },
                      "status" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Defines the status for each payment schedule.\n\n* paid - paid\n* posted - posted\n* payment_due - payment_due\n",
                        "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.\n",
            "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.\n",
                "example" : null
              },
              "price_type" : {
                "type" : "string",
                "default" : "tax_exclusive",
                "deprecated" : false,
                "description" : "The price type of this invoice.\n\n* tax_exclusive - All amounts in the document are exclusive of tax.\n* tax_inclusive - All amounts in the document are inclusive of tax.\n",
                "enum" : [ "tax_exclusive", "tax_inclusive" ],
                "example" : null
              },
              "currency_code" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The currency code (ISO 4217 format) of the invoice.\n",
                "maxLength" : 3,
                "example" : null
              },
              "sub_total" : {
                "type" : "integer",
                "format" : "int64",
                "deprecated" : false,
                "description" : "Invoice sub-total in cents.\n",
                "minimum" : 0,
                "example" : null
              },
              "total" : {
                "type" : "integer",
                "format" : "int64",
                "default" : 0,
                "deprecated" : false,
                "description" : "Invoice total in cents.\n",
                "minimum" : 0,
                "example" : null
              },
              "credits_applied" : {
                "type" : "integer",
                "format" : "int64",
                "default" : 0,
                "deprecated" : false,
                "description" : "credits applied to this invoice in cents.\n",
                "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.\n",
                "minimum" : 0,
                "example" : null
              },
              "amount_due" : {
                "type" : "integer",
                "format" : "int64",
                "default" : 0,
                "deprecated" : false,
                "description" : "Invoice amount due in cents\n",
                "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\n",
                      "maxLength" : 40,
                      "example" : null
                    },
                    "subscription_id" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "A unique identifier for the subscription this line item belongs to.\n",
                      "maxLength" : 50,
                      "example" : null
                    },
                    "date_from" : {
                      "type" : "integer",
                      "format" : "unix-time",
                      "deprecated" : false,
                      "description" : "Start date of this line item.\n",
                      "example" : null
                    },
                    "date_to" : {
                      "type" : "integer",
                      "format" : "unix-time",
                      "deprecated" : false,
                      "description" : "End date of this line item.\n",
                      "example" : null
                    },
                    "unit_amount" : {
                      "type" : "integer",
                      "format" : "int64",
                      "deprecated" : false,
                      "description" : "Unit amount of the line item.\n",
                      "example" : null
                    },
                    "quantity" : {
                      "type" : "integer",
                      "format" : "int32",
                      "default" : 1,
                      "deprecated" : false,
                      "description" : "[Quantity of the recurring item](/docs/api/v2/pcv-1/invoices/invoice-object#line_items_quantity)\nwhich is represented by this line item.\n",
                      "example" : null
                    },
                    "amount" : {
                      "type" : "integer",
                      "format" : "int64",
                      "deprecated" : false,
                      "description" : "Total amount of this line item. Typically equals to unit amount x quantity\n",
                      "example" : null
                    },
                    "pricing_model" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "The [pricing scheme](https://www.chargebee.com/docs/plans.html#pricing-attributes_pricing-model)\nfor this item.\n\n* stairstep - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.\n* volume - The per unit price is based on the tier that the total quantity falls in.\n* per_unit - A fixed price per unit quantity.\n* tiered - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.\n* flat_fee - A fixed price that is not quantity-based.\n",
                      "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\n",
                      "example" : null
                    },
                    "tax_amount" : {
                      "type" : "integer",
                      "format" : "int64",
                      "default" : 0,
                      "deprecated" : false,
                      "description" : "The tax amount charged for this item\n",
                      "minimum" : 0,
                      "example" : null
                    },
                    "tax_rate" : {
                      "type" : "number",
                      "format" : "double",
                      "deprecated" : false,
                      "description" : "Rate of tax used to calculate tax for this lineitem\n",
                      "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`.\nThe value is in major units of the currency. Returned when the `line_item`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                      "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`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                      "maxLength" : 33,
                      "example" : null
                    },
                    "amount_in_decimal" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "The decimal representation of the amount for the `line_item`\n, in major units of the currency. Typically equals to `unit_amount_in_decimal`\nx `quantity_in_decimal`.\nReturned when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                      "maxLength" : 39,
                      "example" : null
                    },
                    "discount_amount" : {
                      "type" : "integer",
                      "format" : "int64",
                      "deprecated" : false,
                      "description" : "Total discounts for this line\n",
                      "minimum" : 0,
                      "example" : null
                    },
                    "item_level_discount_amount" : {
                      "type" : "integer",
                      "format" : "int64",
                      "deprecated" : false,
                      "description" : "Line Item-level discounts for this line.\n",
                      "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.\n",
                      "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\n",
                      "maxLength" : 40,
                      "example" : null
                    },
                    "description" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "Detailed description about this line item.\n",
                      "maxLength" : 250,
                      "example" : null
                    },
                    "entity_description" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "Detailed description about this item.\n",
                      "maxLength" : 2000,
                      "example" : null
                    },
                    "entity_type" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "Specifies the modelled entity this line item is based on.\n\n* plan_setup -\n  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)\n  id\n* addon -\n  Indicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the [addon](/docs/api/v2/pcv-1/addons/addon-object)\n  id\n* adhoc - Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case\n* plan -\n  Indicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)\n  id\n",
                      "enum" : [ "plan_setup", "plan", "addon", "adhoc" ],
                      "example" : null
                    },
                    "tax_exempt_reason" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "The reason due to which the line item price/amount is exempted from tax.\n\n* export -\n  You are not registered for tax in the customer's region. This is also the reason code when both `billing_address`\n  and `shipping_address`\n  have not been provided for the customer and subscription respectively\n* 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.\n* tax_not_configured_external_provider - If the tax is not configured for the country in 3rd party tax provider.\n* zero_rated - If the rate of tax is 0% and no Sales/ GST tax is collectable for that line item\n* reverse_charge - If the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU only\n* tax_not_configured - If tax is not enabled for the site\n* 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\n* 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\n* product_exempt - If the Plan or Addon is marked as Tax exempt\n* customer_exempt - If the Customer is marked as Tax exempt\n",
                      "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\n",
                      "maxLength" : 100,
                      "example" : null
                    },
                    "customer_id" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "A unique identifier for the customer this line item belongs to\n",
                      "maxLength" : 100,
                      "example" : null
                    },
                    "proration_mode" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "Proration mode for the line item.\n",
                      "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\n",
                "items" : {
                  "type" : "object",
                  "deprecated" : false,
                  "properties" : {
                    "line_item_id" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "Uniquely identifies a line_item\n",
                      "maxLength" : 40,
                      "example" : null
                    },
                    "starting_unit" : {
                      "type" : "integer",
                      "format" : "int32",
                      "deprecated" : false,
                      "description" : "The lower limit of a range of units for the tier\n",
                      "minimum" : 0,
                      "example" : null
                    },
                    "ending_unit" : {
                      "type" : "integer",
                      "format" : "int32",
                      "deprecated" : false,
                      "description" : "The upper limit of a range of units for the tier\n",
                      "example" : null
                    },
                    "quantity_used" : {
                      "type" : "integer",
                      "format" : "int32",
                      "deprecated" : false,
                      "description" : "The number of units purchased in a range.\n",
                      "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`\npricing , or the price of each unit in the tier if the charge model is `tiered`\n/`volume`\npricing.\n",
                      "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`\nof the next lower tier. Returned only when the `line_items.pricing_model`\nis `tiered`\n, `volume`\nor `stairstep`\nand [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                      "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`\nof the next higher tier. Returned only when the `line_items.pricing_model`\nis `tiered`\n, `volume`\nor stairstep and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                      "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`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                      "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`\nis `tiered`\nor `volume`.\nWhen the `pricing_model`\nis `stairstep`\n, it is the decimal representation of the total price for `line_item`.\nThe value is in major units of the currency. Returned when the `line_item`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                      "maxLength" : 40,
                      "example" : null
                    },
                    "pricing_type" : {
                      "type" : "string",
                      "deprecated" : false,
                      "enum" : [ "per_unit", "flat_fee", "package" ],
                      "example" : null
                    },
                    "package_size" : {
                      "type" : "integer",
                      "format" : "int32",
                      "deprecated" : false,
                      "minimum" : 1,
                      "example" : null
                    }
                  },
                  "required" : [ "quantity_used", "starting_unit", "unit_amount" ],
                  "example" : null
                },
                "example" : null
              },
              "line_item_discounts" : {
                "type" : "array",
                "deprecated" : false,
                "description" : "The list of discount(s) applied for each line item of this invoice.\n",
                "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.\n",
                      "maxLength" : 50,
                      "example" : null
                    },
                    "discount_type" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "The type of deduction and the amount to which it is applied.\n\n* item_level_coupon -\n  The deduction is due to a coupon applied to a line item of the invoice. The coupon `id`\n  is available as `entity_id`\n  .\n* document_level_coupon -\n  The deduction is due to a coupon applied to the invoice `sub_total`.\n  The coupon `id`\n  is available as `entity_id`\n  .\n* prorated_credits -\n  The deduction is due to a legacy adjustment credit applied to the invoice. The `entity_id`\n  is `null`\n  in this case. The legacy credits feature is superseded by [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)\n  .\n* promotional_credits -\n  The deduction is due to a [promotional credit](/docs/api/promotional_credits)\n  applied to the invoice. The `entity_id`\n  is `null`\n  in this case.\n",
                      "enum" : [ "item_level_coupon", "document_level_coupon", "promotional_credits", "prorated_credits" ],
                      "example" : null
                    },
                    "coupon_id" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "When the deduction is due to a coupon, then this is the id of the coupon.\n",
                      "maxLength" : 50,
                      "example" : null
                    },
                    "entity_id" : {
                      "type" : "string",
                      "deprecated" : false,
                      "maxLength" : 50,
                      "example" : null
                    },
                    "discount_amount" : {
                      "type" : "integer",
                      "format" : "int64",
                      "deprecated" : false,
                      "description" : "The amount deducted. The format of this value depends on the [kind of currency](/docs/api/currencies)\n.\n",
                      "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\n",
                "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\n",
                      "maxLength" : 40,
                      "example" : null
                    },
                    "tax_name" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "The name of the tax applied\n",
                      "maxLength" : 100,
                      "example" : null
                    },
                    "tax_rate" : {
                      "type" : "number",
                      "format" : "double",
                      "default" : 0,
                      "deprecated" : false,
                      "description" : "The rate of tax used to calculate tax amount\n",
                      "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.\n",
                      "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.\n",
                      "example" : null
                    },
                    "prorated_taxable_amount" : {
                      "type" : "number",
                      "format" : "decimal",
                      "deprecated" : false,
                      "description" : "Indicates the prorated line item amount in cents.\n",
                      "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.\n",
                      "example" : null
                    },
                    "is_non_compliance_tax" : {
                      "type" : "boolean",
                      "deprecated" : false,
                      "description" : "Indicates the non-compliance tax that should not be reported to the jurisdiction.\n",
                      "example" : null
                    },
                    "taxable_amount" : {
                      "type" : "integer",
                      "format" : "int64",
                      "deprecated" : false,
                      "description" : "Indicates the actual portion of the line item amount that is taxable.\n",
                      "minimum" : 0,
                      "example" : null
                    },
                    "tax_amount" : {
                      "type" : "integer",
                      "format" : "int64",
                      "deprecated" : false,
                      "description" : "The tax amount\n",
                      "minimum" : 0,
                      "example" : null
                    },
                    "tax_juris_type" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "The type of tax jurisdiction\n\n* state - The tax jurisdiction is a state\n* federal - The tax jurisdiction is a federal\n* county - The tax jurisdiction is a county\n* special - Special tax jurisdiction.\n* unincorporated - Combined tax of state and county.\n* country - The tax jurisdiction is a country\n* other - Jurisdictions other than the ones listed above.\n* city - The tax jurisdiction is a city\n",
                      "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\n",
                      "maxLength" : 250,
                      "example" : null
                    },
                    "tax_juris_code" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "The tax jurisdiction code\n",
                      "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.\n",
                      "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.\n",
                      "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.\n",
                "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.\n",
                      "maxLength" : 50,
                      "example" : null
                    },
                    "applied_amount" : {
                      "type" : "number",
                      "format" : "double",
                      "default" : 0,
                      "deprecated" : false,
                      "description" : "The credit amount is applied to the line item.\n",
                      "example" : null
                    },
                    "line_item_id" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "The unique ID of the line item to which this credit is applied.\n",
                      "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.\n",
                "items" : {
                  "type" : "object",
                  "deprecated" : false,
                  "properties" : {
                    "line_item_id" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "Line item reference\n",
                      "maxLength" : 40,
                      "example" : null
                    },
                    "first_name" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "First name of the customer\n",
                      "maxLength" : 150,
                      "example" : null
                    },
                    "last_name" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "Last name of the customer\n",
                      "maxLength" : 150,
                      "example" : null
                    },
                    "email" : {
                      "type" : "string",
                      "format" : "email",
                      "deprecated" : false,
                      "description" : "Email of the customer\n",
                      "maxLength" : 70,
                      "example" : null
                    },
                    "company" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "Name of the company\n",
                      "maxLength" : 250,
                      "example" : null
                    },
                    "phone" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "Phone number of the customer\n",
                      "maxLength" : 50,
                      "example" : null
                    },
                    "line1" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "Address line 1\n",
                      "maxLength" : 150,
                      "example" : null
                    },
                    "line2" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "Address line 2\n",
                      "maxLength" : 150,
                      "example" : null
                    },
                    "line3" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "Address line 3\n",
                      "maxLength" : 150,
                      "example" : null
                    },
                    "city" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "Name of the city\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)\nwithout the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n).\n",
                      "maxLength" : 50,
                      "example" : null
                    },
                    "state" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "State or Province\n",
                      "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).\nEntering 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)\n.\n",
                      "maxLength" : 20,
                      "example" : null
                    },
                    "validation_status" : {
                      "type" : "string",
                      "default" : "not_validated",
                      "deprecated" : false,
                      "description" : "The address verification status.\n\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* valid - Address was validated successfully.\n* not_validated - Address is not yet validated.\n* invalid - Address is invalid.\n",
                      "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\n",
                "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)\n.\n",
                      "minimum" : 0,
                      "example" : null
                    },
                    "description" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "Description for this deduction.\n",
                      "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]`\nis `item_level_coupon`\nor `document_level_coupon`\n.\n",
                      "maxLength" : 40,
                      "example" : null
                    },
                    "entity_type" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "The type of deduction and the amount to which it is applied.\n\n* promotional_credits -\n  The deduction is due to a [promotional credit](/docs/api/promotional_credits)\n  applied to the invoice.\n* prorated_credits -\n  The deduction is due to a legacy adjustment credit applied to the invoice. The `entity_id`\n  is `null`\n  in this case. The legacy credits feature is superseded by [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)\n  .\n* document_level_coupon -\n  The deduction is due to a coupon applied to the invoice `sub_total`.\n  The coupon id is passed as `entity_id`\n  .\n* item_level_coupon -\n  The deduction is due to a coupon applied to line item. The coupon `id`\n  is passed as `entity_id`\n  .\n",
                      "enum" : [ "item_level_coupon", "document_level_coupon", "promotional_credits", "prorated_credits" ],
                      "example" : null
                    },
                    "discount_type" : {
                      "type" : "string",
                      "deprecated" : false,
                      "enum" : [ "fixed_amount", "percentage" ],
                      "example" : null
                    },
                    "entity_id" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "When the deduction is due to a `coupon`\n, then this is the `id`\nof the coupon.\n",
                      "maxLength" : 100,
                      "example" : null
                    },
                    "coupon_set_code" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "The [coupon code](/docs/api/coupon_codes/coupon_code-object#code)\n, if applicable, used to provide the discount. The [coupon.id](/docs/api/coupons/coupon-object#id)\nis available in `entity_id`\n.\n",
                      "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\n",
                "items" : {
                  "type" : "object",
                  "deprecated" : false,
                  "properties" : {
                    "name" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "The name of the tax applied. E.g. GST.\n",
                      "maxLength" : 100,
                      "example" : null
                    },
                    "amount" : {
                      "type" : "integer",
                      "format" : "int64",
                      "deprecated" : false,
                      "description" : "The tax amount.\n",
                      "minimum" : 0,
                      "example" : null
                    },
                    "description" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "Description of the tax item.\n",
                      "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`.\nIf there is no `round-off amount`\n, it will display `0`\n.\n",
                "minimum" : 0,
                "example" : null
              },
              "customer_id" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "A unique identifier for the customer this invoice belongs to\n",
                "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.\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "reference_invoice_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The reference invoice id\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Credit note type. [Learn more](/docs/api/v2/pcv-1/credit_notes/credit-note-object)\nabout credit note types.\n\n* refundable - Refundable Credit Note\n* adjustment - Adjustment Credit Note\n* store - Store Credit Note\n",
                  "enum" : [ "adjustment", "refundable", "store" ],
                  "example" : null
                },
                "price_type" : {
                  "type" : "string",
                  "default" : "tax_exclusive",
                  "deprecated" : false,
                  "description" : "The price type of this credit note.\n\n* tax_inclusive - All amounts in the document are inclusive of tax.\n* tax_exclusive - All amounts in the document are exclusive of tax.\n",
                  "enum" : [ "tax_exclusive", "tax_inclusive" ],
                  "example" : null
                },
                "currency_code" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The currency code (ISO 4217 format) of the credit note.\n",
                  "maxLength" : 3,
                  "example" : null
                },
                "sub_total" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Invoice sub-total in cents.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "total" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Credit note total in cents.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "amount_allocated" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Allocated credits in cents.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "amount_available" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Remaining credits in cents\n",
                  "minimum" : 0,
                  "example" : null
                },
                "line_items" : {
                  "type" : "array",
                  "deprecated" : false,
                  "description" : "The list of items in this estimate\n",
                  "items" : {
                    "type" : "object",
                    "deprecated" : false,
                    "properties" : {
                      "id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Uniquely identifies a line_item\n",
                        "maxLength" : 40,
                        "example" : null
                      },
                      "subscription_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "A unique identifier for the subscription this line item belongs to.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "date_from" : {
                        "type" : "integer",
                        "format" : "unix-time",
                        "deprecated" : false,
                        "description" : "Start date of this line item.\n",
                        "example" : null
                      },
                      "date_to" : {
                        "type" : "integer",
                        "format" : "unix-time",
                        "deprecated" : false,
                        "description" : "End date of this line item.\n",
                        "example" : null
                      },
                      "unit_amount" : {
                        "type" : "integer",
                        "format" : "int64",
                        "deprecated" : false,
                        "description" : "Unit amount of the line item.\n",
                        "example" : null
                      },
                      "quantity" : {
                        "type" : "integer",
                        "format" : "int32",
                        "default" : 1,
                        "deprecated" : false,
                        "description" : "[Quantity of the recurring item](/docs/api/v2/pcv-1/invoices/invoice-object#line_items_quantity)\nwhich is represented by this line item.\n",
                        "example" : null
                      },
                      "amount" : {
                        "type" : "integer",
                        "format" : "int64",
                        "deprecated" : false,
                        "description" : "Total amount of this line item. Typically equals to unit amount x quantity\n",
                        "example" : null
                      },
                      "pricing_model" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The [pricing scheme](https://www.chargebee.com/docs/plans.html#pricing-attributes_pricing-model)\nfor this item.\n\n* volume - The per unit price is based on the tier that the total quantity falls in.\n* tiered - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.\n* per_unit - A fixed price per unit quantity.\n* stairstep - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.\n* flat_fee - A fixed price that is not quantity-based.\n",
                        "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\n",
                        "example" : null
                      },
                      "tax_amount" : {
                        "type" : "integer",
                        "format" : "int64",
                        "default" : 0,
                        "deprecated" : false,
                        "description" : "The tax amount charged for this item\n",
                        "minimum" : 0,
                        "example" : null
                      },
                      "tax_rate" : {
                        "type" : "number",
                        "format" : "double",
                        "deprecated" : false,
                        "description" : "Rate of tax used to calculate tax for this lineitem\n",
                        "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`.\nThe value is in major units of the currency. Returned when the `line_item`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "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`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "maxLength" : 33,
                        "example" : null
                      },
                      "amount_in_decimal" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The decimal representation of the amount for the `line_item`\n, in major units of the currency. Typically equals to `unit_amount_in_decimal`\nx `quantity_in_decimal`.\nReturned when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "maxLength" : 39,
                        "example" : null
                      },
                      "discount_amount" : {
                        "type" : "integer",
                        "format" : "int64",
                        "deprecated" : false,
                        "description" : "Total discounts for this line\n",
                        "minimum" : 0,
                        "example" : null
                      },
                      "item_level_discount_amount" : {
                        "type" : "integer",
                        "format" : "int64",
                        "deprecated" : false,
                        "description" : "Line Item-level discounts for this line.\n",
                        "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.\n",
                        "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\n",
                        "maxLength" : 40,
                        "example" : null
                      },
                      "description" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Detailed description about this line item.\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "entity_description" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Detailed description about this item.\n",
                        "maxLength" : 2000,
                        "example" : null
                      },
                      "entity_type" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Specifies the modelled entity this line item is based on.\n\n* plan_setup -\n  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)\n  id\n* plan -\n  Indicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)\n  id\n* addon -\n  Indicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the [addon](/docs/api/v2/pcv-1/addons/addon-object)\n  id\n* adhoc - Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case\n",
                        "enum" : [ "plan_setup", "plan", "addon", "adhoc" ],
                        "example" : null
                      },
                      "tax_exempt_reason" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The reason due to which the line item price/amount is exempted from tax.\n\n* export -\n  You are not registered for tax in the customer's region. This is also the reason code when both `billing_address`\n  and `shipping_address`\n  have not been provided for the customer and subscription respectively\n* zero_rated - If the rate of tax is 0% and no Sales/ GST tax is collectable for that line item\n* tax_not_configured_external_provider - If the tax is not configured for the country in 3rd party tax provider.\n* 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\n* tax_not_configured - If tax is not enabled for the site\n* 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.\n* product_exempt - If the Plan or Addon is marked as Tax exempt\n* 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\n* reverse_charge - If the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU only\n* customer_exempt - If the Customer is marked as Tax exempt\n",
                        "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\n",
                        "maxLength" : 100,
                        "example" : null
                      },
                      "customer_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "A unique identifier for the customer this line item belongs to\n",
                        "maxLength" : 100,
                        "example" : null
                      },
                      "proration_mode" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Proration mode for the line item.\n",
                        "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\n",
                  "items" : {
                    "type" : "object",
                    "deprecated" : false,
                    "properties" : {
                      "line_item_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Uniquely identifies a line_item\n",
                        "maxLength" : 40,
                        "example" : null
                      },
                      "starting_unit" : {
                        "type" : "integer",
                        "format" : "int32",
                        "deprecated" : false,
                        "description" : "The lower limit of a range of units for the tier\n",
                        "minimum" : 0,
                        "example" : null
                      },
                      "ending_unit" : {
                        "type" : "integer",
                        "format" : "int32",
                        "deprecated" : false,
                        "description" : "The upper limit of a range of units for the tier\n",
                        "example" : null
                      },
                      "quantity_used" : {
                        "type" : "integer",
                        "format" : "int32",
                        "deprecated" : false,
                        "description" : "The number of units purchased in a range.\n",
                        "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`\npricing , or the price of each unit in the tier if the charge model is `tiered`\n/`volume`\npricing.\n",
                        "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`\nof the next lower tier. Returned only when the `line_items.pricing_model`\nis `tiered`\n, `volume`\nor `stairstep`\nand [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "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`\nof the next higher tier. Returned only when the `line_items.pricing_model`\nis `tiered`\n, `volume`\nor stairstep and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "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`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "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`\nis `tiered`\nor `volume`.\nWhen the `pricing_model`\nis `stairstep`\n, it is the decimal representation of the total price for `line_item`.\nThe value is in major units of the currency. Returned when the `line_item`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "maxLength" : 40,
                        "example" : null
                      },
                      "pricing_type" : {
                        "type" : "string",
                        "deprecated" : false,
                        "enum" : [ "per_unit", "flat_fee", "package" ],
                        "example" : null
                      },
                      "package_size" : {
                        "type" : "integer",
                        "format" : "int32",
                        "deprecated" : false,
                        "minimum" : 1,
                        "example" : null
                      }
                    },
                    "required" : [ "quantity_used", "starting_unit", "unit_amount" ],
                    "example" : null
                  },
                  "example" : null
                },
                "line_item_discounts" : {
                  "type" : "array",
                  "deprecated" : false,
                  "description" : "The list of discount(s) applied for each line item of this invoice.\n",
                  "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.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "discount_type" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The type of deduction and the amount to which it is applied.\n\n* prorated_credits -\n  The deduction is due to a legacy adjustment credit applied to the invoice. The `entity_id`\n  is `null`\n  in this case. The legacy credits feature is superseded by [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)\n  .\n* item_level_coupon -\n  The deduction is due to a coupon applied to a line item of the invoice. The coupon `id`\n  is available as `entity_id`\n  .\n* promotional_credits -\n  The deduction is due to a [promotional credit](/docs/api/promotional_credits)\n  applied to the invoice. The `entity_id`\n  is `null`\n  in this case.\n* document_level_coupon -\n  The deduction is due to a coupon applied to the invoice `sub_total`.\n  The coupon `id`\n  is available as `entity_id`\n  .\n",
                        "enum" : [ "item_level_coupon", "document_level_coupon", "promotional_credits", "prorated_credits" ],
                        "example" : null
                      },
                      "coupon_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "When the deduction is due to a coupon, then this is the id of the coupon.\n",
                        "maxLength" : 50,
                        "example" : null
                      },
                      "entity_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "maxLength" : 50,
                        "example" : null
                      },
                      "discount_amount" : {
                        "type" : "integer",
                        "format" : "int64",
                        "deprecated" : false,
                        "description" : "The amount deducted. The format of this value depends on the [kind of currency](/docs/api/currencies)\n.\n",
                        "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\n",
                  "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\n",
                        "maxLength" : 40,
                        "example" : null
                      },
                      "tax_name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the tax applied\n",
                        "maxLength" : 100,
                        "example" : null
                      },
                      "tax_rate" : {
                        "type" : "number",
                        "format" : "double",
                        "default" : 0,
                        "deprecated" : false,
                        "description" : "The rate of tax used to calculate tax amount\n",
                        "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.\n",
                        "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.\n",
                        "example" : null
                      },
                      "prorated_taxable_amount" : {
                        "type" : "number",
                        "format" : "decimal",
                        "deprecated" : false,
                        "description" : "Indicates the prorated line item amount in cents.\n",
                        "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.\n",
                        "example" : null
                      },
                      "is_non_compliance_tax" : {
                        "type" : "boolean",
                        "deprecated" : false,
                        "description" : "Indicates the non-compliance tax that should not be reported to the jurisdiction.\n",
                        "example" : null
                      },
                      "taxable_amount" : {
                        "type" : "integer",
                        "format" : "int64",
                        "deprecated" : false,
                        "description" : "Indicates the actual portion of the line item amount that is taxable.\n",
                        "minimum" : 0,
                        "example" : null
                      },
                      "tax_amount" : {
                        "type" : "integer",
                        "format" : "int64",
                        "deprecated" : false,
                        "description" : "The tax amount\n",
                        "minimum" : 0,
                        "example" : null
                      },
                      "tax_juris_type" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The type of tax jurisdiction\n\n* county - The tax jurisdiction is a county\n* country - The tax jurisdiction is a country\n* unincorporated - Combined tax of state and county.\n* city - The tax jurisdiction is a city\n* federal - The tax jurisdiction is a federal\n* state - The tax jurisdiction is a state\n* other - Jurisdictions other than the ones listed above.\n* special - Special tax jurisdiction.\n",
                        "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\n",
                        "maxLength" : 250,
                        "example" : null
                      },
                      "tax_juris_code" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The tax jurisdiction code\n",
                        "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.\n",
                        "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.\n",
                        "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\n",
                  "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)\n.\n",
                        "minimum" : 0,
                        "example" : null
                      },
                      "description" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Description for this deduction.\n",
                        "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]`\nis `item_level_coupon`\nor `document_level_coupon`\n.\n",
                        "maxLength" : 40,
                        "example" : null
                      },
                      "entity_type" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The type of deduction and the amount to which it is applied.\n\n* document_level_coupon -\n  The deduction is due to a coupon applied to the invoice `sub_total`.\n  The coupon id is passed as `entity_id`\n  .\n* promotional_credits -\n  The deduction is due to a [promotional credit](/docs/api/promotional_credits)\n  applied to the invoice.\n* prorated_credits -\n  The deduction is due to a legacy adjustment credit applied to the invoice. The `entity_id`\n  is `null`\n  in this case. The legacy credits feature is superseded by [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)\n  .\n* item_level_coupon -\n  The deduction is due to a coupon applied to line item. The coupon `id`\n  is passed as `entity_id`\n  .\n",
                        "enum" : [ "item_level_coupon", "document_level_coupon", "promotional_credits", "prorated_credits" ],
                        "example" : null
                      },
                      "discount_type" : {
                        "type" : "string",
                        "deprecated" : false,
                        "enum" : [ "fixed_amount", "percentage" ],
                        "example" : null
                      },
                      "entity_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "When the deduction is due to a `coupon`\n, then this is the `id`\nof the coupon.\n",
                        "maxLength" : 100,
                        "example" : null
                      },
                      "coupon_set_code" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The [coupon code](/docs/api/coupon_codes/coupon_code-object#code)\n, if applicable, used to provide the discount. The [coupon.id](/docs/api/coupons/coupon-object#id)\nis available in `entity_id`\n.\n",
                        "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\n",
                  "items" : {
                    "type" : "object",
                    "deprecated" : false,
                    "properties" : {
                      "name" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "The name of the tax applied. E.g. GST.\n",
                        "maxLength" : 100,
                        "example" : null
                      },
                      "amount" : {
                        "type" : "integer",
                        "format" : "int64",
                        "deprecated" : false,
                        "description" : "The tax amount.\n",
                        "minimum" : 0,
                        "example" : null
                      },
                      "description" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Description of the tax item.\n",
                        "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`.\nIf there is no `round-off amount`\n, it will display `0`\n.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "customer_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "A unique identifier for the customer this credit note belongs to\n",
                  "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.\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Uniquely identifies an unbilled charge.\n",
                  "maxLength" : 40,
                  "example" : null
                },
                "customer_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "A unique identifier for the customer being charged.\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "subscription_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "A unique identifier for the subscription this charge belongs to.\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "date_from" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "Start date of this charge.\n",
                  "example" : null
                },
                "date_to" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "End date of this charge.\n",
                  "example" : null
                },
                "unit_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Unit amount of the charge item.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "pricing_model" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The pricing scheme for this line item.\n\n* tiered - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.\n* stairstep - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.\n* volume - The per unit price is based on the tier that the total quantity falls in.\n* per_unit - A fixed price per unit quantity.\n* flat_fee - A fixed price that is not quantity-based.\n",
                  "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.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Total amount of this charge. Typically equals to unit amount x quantity.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "currency_code" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The currency code (ISO 4217 format) for the charge.\n",
                  "maxLength" : 3,
                  "example" : null
                },
                "discount_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Total discounts for this charge.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "description" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Detailed description about this charge.\n",
                  "maxLength" : 250,
                  "example" : null
                },
                "entity_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Specifies the modelled entity this line item is based on.\n\n* plan_setup -\n  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)\n  id\n* addon -\n  Indicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the [addon](/docs/api/v2/pcv-1/addons/addon-object)\n  id\n* plan -\n  Indicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)\n  id\n* adhoc - Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case\n",
                  "enum" : [ "plan_setup", "plan", "addon", "adhoc" ],
                  "example" : null
                },
                "entity_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The identifier of the modelled entity this charge is based on. Will be null for 'adhoc' entity type.\n",
                  "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.\n",
                  "example" : null
                },
                "voided_at" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "Timestamp indicating the date and time this charge got voided.\n",
                  "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`\nx `quantity_in_decimal`.\nReturned when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "maxLength" : 39,
                  "example" : null
                },
                "quantity_in_decimal" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The decimal representation of the quantity of this entity. Returned when the entity is quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "maxLength" : 33,
                  "example" : null
                },
                "amount_in_decimal" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The decimal representation of the unit amount for the entity. The value is in major units of the currency. Returned when the entity is quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "maxLength" : 39,
                  "example" : null
                },
                "created_at" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "Timestamp indicating when the unbilled charge was created.\n",
                  "example" : null
                },
                "updated_at" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "Timestamp indicating when the unbilled charge was last updated\n",
                  "example" : null
                },
                "tiers" : {
                  "type" : "array",
                  "deprecated" : false,
                  "description" : "The list of tiers applicable for this line item\n",
                  "items" : {
                    "type" : "object",
                    "deprecated" : false,
                    "properties" : {
                      "line_item_id" : {
                        "type" : "string",
                        "deprecated" : false,
                        "description" : "Uniquely identifies a line_item\n",
                        "maxLength" : 40,
                        "example" : null
                      },
                      "starting_unit" : {
                        "type" : "integer",
                        "format" : "int32",
                        "deprecated" : false,
                        "description" : "The lower limit of a range of units for the tier\n",
                        "minimum" : 0,
                        "example" : null
                      },
                      "ending_unit" : {
                        "type" : "integer",
                        "format" : "int32",
                        "deprecated" : false,
                        "description" : "The upper limit of a range of units for the tier\n",
                        "example" : null
                      },
                      "quantity_used" : {
                        "type" : "integer",
                        "format" : "int32",
                        "deprecated" : false,
                        "description" : "The number of units purchased in a range.\n",
                        "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`\npricing , or the price of each unit in the tier if the charge model is `tiered`\n/`volume`\npricing.\n",
                        "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`\nof the next lower tier. Returned only when the `line_items.pricing_model`\nis `tiered`\n, `volume`\nor `stairstep`\nand [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "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`\nof the next higher tier. Returned only when the `line_items.pricing_model`\nis `tiered`\n, `volume`\nor stairstep and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "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`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "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`\nis `tiered`\nor `volume`.\nWhen the `pricing_model`\nis `stairstep`\n, it is the decimal representation of the total price for `line_item`.\nThe value is in major units of the currency. Returned when the `line_item`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                        "maxLength" : 40,
                        "example" : null
                      },
                      "pricing_type" : {
                        "type" : "string",
                        "deprecated" : false,
                        "enum" : [ "per_unit", "flat_fee", "package" ],
                        "example" : null
                      },
                      "package_size" : {
                        "type" : "integer",
                        "format" : "int32",
                        "deprecated" : false,
                        "minimum" : 1,
                        "example" : null
                      }
                    },
                    "required" : [ "quantity_used", "starting_unit", "unit_amount" ],
                    "example" : null
                  },
                  "example" : null
                },
                "is_advance_charge" : {
                  "type" : "boolean",
                  "default" : false,
                  "deprecated" : false,
                  "description" : "The value of this parameter will be true if it is a recurring unbilled charge for a future term.\n",
                  "example" : null
                },
                "business_entity_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity.  \n**Note**\n\n[Multiple Business Entities](/docs/api/getting-started) is a feature available only on Product Catalog 2.0.\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "deleted" : {
                  "type" : "boolean",
                  "deprecated" : false,
                  "description" : "Indicates that this resource has been deleted.\n",
                  "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\n\nWhenever any important changes happen in your Chargebee site, they are recorded as events. An event contains data about affected resources and additional details such as when the change occurred. For example, when a subscription is cancelled due to non payment, an event `subscription_cancelled` is recorded.\n\n### Webhooks\n\nIf webhooks have been [configured](https://www.chargebee.com/docs/webhook_settings.html#configure-webhooks) in Chargebee, events trigger those webhooks. If multiple webhooks have been configured, for every event, each webhook is called one after another. If a webhook call for an event fails or times out, it is retried based on a [fixed schedule](https://www.chargebee.com/docs/webhook_settings.html#automatic-retries). The webhook call is an HTTP POST with content type `application/json`.\n\n#### Retries \\& Duplicate Handling\n\nTo mark a webhook notification successful, we expect the [HTTP status code](http://en.wikipedia.org/wiki/List_of_HTTP_status_codes) to be `2XX` from your webhook URL. If we don't receive `2XX` response code, we [retry](https://www.chargebee.com/docs/webhook_settings.html#automatic-retries) calling your webhook with a progressively increasing delay for the next 2 days. You could also [resend](https://www.chargebee.com/docs/webhook_settings.html#automatic-retries) webhooks manually from the web console.\nDue to webhook retries, it's possible that your application receives the same webhook more than once. Ensure idempotency of the webhook call by detecting such duplicates within your application. This can be done by examining the [id](/docs/api/events/event-object#id) parameter since its value uniquely identifies an event.\nFor example, your application could do the following for each webhook notification:\n\n1. Get the event `id` and keep it in a persistent store such as a relational database or redis.\n2. Check whether the event `id` is already processed.\n3. If the event has not been processed then process the event; otherwise, it is a duplicate event so can be ignored.\n4. Also, since the last retry for a webhook happens at around 3 days and 7 hours after the original event trigger, keep the idempotency window as 3 days and 7 hours. In other words, you may purge the stored event ids that are more than 3 days and 7 hours old.\n\n#### Out-of-order Delivery\n\nWebhooks 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.\nFor example, if you wish to sync resource changes from Chargebee to your application, you could:\n\n1. Get the value (rv1) of the `resource_version` attribute from the resource in the webhook.\n2. Get the value (rv2) of `resource_version` from the resource stored on your side.\n3. If rv1 \\> rv2, process the resource; otherwise, ignore.\n\n**API Version**\nChargebee 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 same as the API version used by your webhook server's client library.\n\n#### Securing Your Webhook URL\n\nYou can have **basic authentication**\nfor the webhook url.\n\n1. In the Webhook Settings page (**Settings \\> Configure Chargebee \\> Webhooks** ),choose the tab for the webhook and check the option **My webhook URL is protected by basic authentication.**\n2. 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\n\nIn 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)\nAPI call.\n\n#### Webhook IP Addresses\n\nWebhooks from Chargebee originate from a [specific set of IP addresses](/docs/api/v2/pcv-1/webhooks).\n",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Uniquely identifies a event\n",
            "maxLength" : 40,
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp indicating when this event had occurred.\n",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "default" : "none",
            "deprecated" : false,
            "description" : "Source of the event\n\n* admin_console - Operation made through the Chargebee admin UI\n* external_service - Operation that are triggered via webhook\n* scheduled_job - Operation made through the Scheduled Jobs\n* bulk_operation - Operation that are triggerd through bulk operation.\n* hosted_page - Operation made through the Hosted Pages\n* portal - Operation made through [Self-Serve Portal](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html)\n* system - Operation that are triggered by ChargeBee System\n* migration - Deprecated\n* none - If no source can be identified for an operation\n* api - Operation made through the API\n* js_api - Operation made through the JS API\n",
            "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`\n\n* When `source` is `admin_console`: the email address of the user that triggered the event.\n* 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.\n* When the `source` is `external_service`: the name of the service that called our webhook. Eg. `ADYEN`, `STRIPE`, `AMAZON_PAYMENTS` etc.\n* When the `source` is `hosted_page` or `portal`: the `user` attribute is not passed.\n",
            "maxLength" : 150,
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The types of event provided by chargebee. Refer [event types](/docs/api/v2/pcv-1/events/event-types)\nfor all the event types provided by us currently.\n\n* card_deleted - Sent when a card is deleted for a customer\n* rule_created - Triggered when a rule is created\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* customer_changed - Sent when a customer is changed\n* invoice_deleted - Event triggered when an invoice is deleted.\n* omnichannel_subscription_item_changed - Triggered when an omnichannel subscription item is changed\n* subscription_shipping_address_updated - Triggered when shipping address is added or updated for a subscription.\n* subscription_created - Sent when a new subscription is created.\n* payment_initiated - Sent when a payment is initiated via direct debit\n* quote_updated - Triggered when quote is updated\n* payment_source_added - Sent when a payment source is added for a customer.\n* contract_term_created - Triggered when new contract term is created\n* subscription_deleted - Sent when a subscription has been deleted\n* voucher_created - Triggered when a payment voucher is created\n* omnichannel_subscription_created - Triggered when an omnichannel subscription is created\n* subscription_ramp_drafted - Triggered when a subscription ramp is moved to draft status.\n* rule_deleted - Triggered when a rule is deleted\n* transaction_deleted - Triggered when a transaction is deleted.\n* payment_failed - Sent when attempt to charge customer's credit card fails\n* subscription_reactivated_with_backdating - Sent when the subscription is moved from cancelled state to active or in_trial state with past date\n* omnichannel_subscription_item_cancellation_scheduled - Triggered when an omnichannel subscription item is scheduled for cancellation\n* payment_source_expiring - Sent when the customer's payment source is expiring soon. Sent 30 days before the expiry date.\n* omnichannel_subscription_item_resumed - Triggered when an omnichannel subscription item is resumed\n* omnichannel_subscription_item_dunning_expired - Triggered when an omnichannel subscription item's dunning has expired\n* order_ready_to_process - Triggered when order reaches it's order date\n* coupon_set_updated - Sent when a coupon set is changed\n* subscription_reactivated - Sent when the subscription is moved from cancelled state to active or in_trial state\n* addon_updated - Sent when a addon is changed.\n* subscription_scheduled_changes_removed - Sent when scheduled change for the subscription is removed.\n* payment_refunded - Sent when a payment refund is made\n* subscription_started - Sent when a 'future' subscription gets started at the scheduled date.\n* token_created - Sent when a Token is created\n* subscription_created_with_backdating - Sent when a new subscription is created with backdating.\n* unbilled_charges_deleted - Triggered when unbilled charges are deleted\n* omnichannel_subscription_item_renewed - Triggered when an omnichannel subscription item is renewed\n* subscription_ramp_applied - Triggered when a subscription ramp is applied.\n* promotional_credits_added - Sent when a customer prmotion credits added\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* card_expired - Sent when a card for a customer is expired\n* payment_intent_created - Sent when a Payment intent is created\n* subscription_changed_with_backdating - Sent after the subscription's recurring items have been changed with backdated date\n* subscription_scheduled_cancellation_removed - Sent when scheduled cancellation is removed for the subscription.\n* omnichannel_subscription_item_resubscribed - Triggered when an omnichannel subscription item is resubscribed\n* plan_deleted - Sent when a plan is deleted.\n* omnichannel_subscription_imported - Triggered when an omnichannel subscription is imported\n* vault_token_created - Triggered when a payment method is tokenized and stored in the vault.\n* tax_withheld_refunded - Sent when a tax withheld refund is made\n* unbilled_charges_voided - Triggered when unbilled charges are voided\n* customer_moved_out - Sent when a customer is copied to another site\n* dunning_updated - Sent when dunning is paused for an invoice\n* record_purchase_failed - Triggered when an omnichannel record purchase fails\n* coupon_codes_deleted - Sent when coupon codes are deleted in coupon set\n* subscription_paused - Sent when the subscription is paused.\n* order_updated - Triggered when order is updated\n* subscription_movement_failed - Triggered when a subscription movement fails\n* unbilled_charges_created - Triggered when unbilled charges are created\n* subscription_moved_in - Triggered when a subscription is moved from another customer\n* subscription_ramp_deleted - Triggered when a subscription ramp is deleted.\n* payment_succeeded - Sent when the payment is successfully collected\n* voucher_expired - Triggered when a payment voucher is expired\n* mrr_updated - Sent when either of MRR or CMRR of a subscription changes\n* subscription_scheduled_resumption_removed - Triggered when scheduled resumption 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* order_ready_to_ship - Triggered when order reaches it's shipping date\n* einvoice_created - Triggered when an e-invoice is created for an invoice or credit note.\n* omnichannel_subscription_item_cancelled - Triggered when an omnichannel subscription item is cancelled\n* subscription_trial_end_reminder - Sent when the customer's trial period is about to end.\n* subscription_renewed - Sent when the subscription is renewed from the current term.\n* vault_token_deleted - Triggered when a vaulted payment method is deleted from the vault.\n* plan_created - Sent when a plan is created.\n* coupon_codes_updated - Sent when coupon codes are updated\n* gift_unclaimed - Triggered when a new gift is unclaimed and is ready to be claimed\n* virtual_bank_account_added - Sent when a virtual bank account is added for a customer.\n* subscription_ramp_updated - Triggered when a subscription ramp is updated.\n* subscription_moved_out - Triggered when a subscription is moved to another customer\n* contract_term_completed - Triggered when contract term is completed\n* subscription_renewal_reminder - Sent before each subscription's renewal based on plan's period\n* coupon_updated - Sent when a coupon is changed.\n* token_consumed - Sent when a Token is consumed\n* omnichannel_subscription_item_upgraded - Triggered when an omnichannel subscription item is upgraded\n* transaction_created - Triggered when a transaction is recorded\n* customer_deleted - Sent when a customer is deleted\n* subscription_items_renewed - Sent when one or more Subscription Items are renewed\n* coupon_deleted - Sent when a coupon is deleted.\n* quote_deleted - Triggered when quote is deleted\n* card_updated - Sent when the card is updated for a customer.\n* coupon_created - Sent when a coupon is created.\n* quote_created - Triggered when quote is created\n* subscription_changed - Sent after the subscription's recurring items have been changed\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* coupon_set_deleted - Sent when a coupon set is deleted\n* refund_initiated - Sent when a refund is initiated via direct debit\n* order_cancelled - Triggered when order is cancelled\n* coupon_codes_added - Sent when coupon codes are added in coupon set\n* omnichannel_subscription_item_paused - Triggered when an omnichannel subscription item is paused\n* card_added - Sent when a card is added for a customer.\n* gift_cancelled - Triggered when a gift is cancelled.\n* omnichannel_subscription_item_downgraded - Triggered when an omnichannel subscription item is downgraded\n* payment_source_deleted - Sent when a payment source is deleted for a customer\n* credit_note_created - Sent when a credit note is created\n* subscription_resumption_scheduled - Triggered when the subscription resumption is scheduled.\n* subscription_advance_invoice_schedule_updated - Triggered when scheduled advance invoice is updated for a subscription.\n* omnichannel_one_time_order_item_cancelled - Triggered when an omnichannel one time order item is cancelled\n* gift_claimed - Triggered when a gift is claimed\n* vault_token_updated - Triggered when a vaulted payment method is updated.\n* subscription_activated - Sent after the subscription has been moved from trial to active state\n* subscription_resumed - Sent when the subscription is moved from paused state to active state\n* sales_order_updated - Triggered when a sales order is updated\n* credit_note_deleted - Sent when a credit note is deleted\n* subscription_advance_invoice_schedule_added - Triggered when advance invoice is scheduled for a subscription.\n* order_deleted - Triggered when order is deleted\n* token_expired - Sent when a Token is expired\n* omnichannel_subscription_item_scheduled_cancellation_removed - Triggered when an omnichannel subscription item scheduled cancellation is removed\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* subscription_cancellation_reminder - Sent when the customer's subscription is nearing it's scheduled cancellation date.\n* rule_updated - Triggered when a rule is updated\n* omnichannel_subscription_item_reactivated - Triggered when an omnichannel subscription item is reactivated\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* order_delivered - Triggered when order is marked as delivered\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* subscription_ramp_created - Triggered when a subscription ramp is created.\n* omnichannel_subscription_item_expired - Triggered when an omnichannel subscription item is expired\n* authorization_succeeded - Triggered when a authorization transaction is created.\n* invoice_generated_with_backdating - Event triggered when a new invoice is generated with past date as invoice date.\n* omnichannel_subscription_item_change_scheduled - Triggered when an omnichannel subscription item change is scheduled\n* subscription_cancellation_scheduled - Sent when subscription is scheduled to cancel at end of current term\n* order_created - Triggered when order is created\n* hierarchy_deleted - Triggered when a hierarchy is deleted\n* subscription_activated_with_backdating - Sent after the subscription changes to `active` from another `status`, while the change is backdated.\n* plan_updated - Sent when a plan is changed.\n* tax_withheld_recorded - Triggered when a tax withheld is recorded for an invoice\n* einvoice_updated - Triggered when an e-invoice is updated (for example when its status or provider responses change).\n* credit_note_created_with_backdating - Sent when a credit note is created with past date as credit note date\n* omnichannel_subscription_item_pause_scheduled - Triggered when an omnichannel subscription item is scheduled for pause\n* gift_updated - Triggered when a gift is updated\n* order_resent - Triggered when order is resent\n* hierarchy_created - Triggered when a hierarchy is created\n* addon_deleted - Sent when a addon is deleted.\n* voucher_create_failed - Triggered when a payment voucher creation is failed\n* customer_moved_in - Sent when a customer is copied from another site\n* omnichannel_subscription_item_grace_period_expired - Triggered when an omnichannel subscription item's grace period has expired\n* unbilled_charges_invoiced - Triggered when unbilled charges are invoiced\n* subscription_pause_scheduled - Sent when the subscription is scheduled to pause.\n* order_returned - Triggered when order is marked as returned\n* payment_source_expired - Sent when a payment source for a customer is expired\n* contract_term_terminated - Triggered when contract term is terminated\n* payment_source_updated - Sent when the payment source is updated for a customer or when role is assigned to the payment source.\n* 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.\n* subscription_advance_invoice_schedule_removed - Triggered when scheduled advance invoice is removed for a subscription.\n* omnichannel_subscription_item_grace_period_started - Triggered when an omnichannel subscription item's grace period has started\n* tax_withheld_deleted - Triggered when a tax withheld is deleted\n* omnichannel_subscription_item_dunning_started - Triggered when an omnichannel subscription item's dunning has started\n* sales_order_created - Triggered when a sales order is created\n* virtual_bank_account_updated - Sent when the virtual bank account is updated for a customer.\n* credit_note_updated - Sent when a credit note is updated\n* subscription_scheduled_pause_removed - Triggered when scheduled pause is removed for the subscription.\n* card_expiry_reminder - Sent when the customer's credit card is expiring soon. Sent 30 days before the expiry date.\n* coupon_set_created - Sent when a coupon set is created\n* virtual_bank_account_deleted - Sent when a virtual bank account is deleted for a customer.\n* omnichannel_one_time_order_created - Triggered when an omnichannel one time order is created\n* gift_scheduled - Triggered when a new gift is created\n* promotional_credits_deducted - Sent when a customer prmotion credits deducted\n* contract_term_renewed - Triggered when new contract term is renewed\n* subscription_trial_extended - Trial Extension\n* gift_expired - Triggered when a gift expires\n* omnichannel_subscription_item_scheduled_change_removed - Triggered when an omnichannel subscription item scheduled change is removed\n* contract_term_cancelled - Triggered when contract term is cancelled\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* addon_created - Sent when a addon is created.\n* 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.\n* payment_intent_updated - Sent when a Payment intent is updated\n* payment_source_locally_deleted - Sent when a payment source for a customer removed from Chargebee\n",
            "enum" : [ "plan_created", "plan_updated", "plan_deleted", "addon_created", "addon_updated", "addon_deleted", "coupon_created", "coupon_updated", "coupon_deleted", "coupon_set_created", "coupon_set_updated", "coupon_set_deleted", "coupon_codes_added", "coupon_codes_deleted", "coupon_codes_updated", "customer_created", "customer_changed", "customer_deleted", "customer_moved_out", "customer_moved_in", "promotional_credits_added", "promotional_credits_deducted", "subscription_created", "subscription_created_with_backdating", "subscription_started", "subscription_trial_end_reminder", "subscription_activated", "subscription_activated_with_backdating", "subscription_changed", "subscription_trial_extended", "mrr_updated", "subscription_changed_with_backdating", "subscription_cancellation_scheduled", "subscription_cancellation_reminder", "subscription_cancelled", "subscription_canceled_with_backdating", "subscription_reactivated", "subscription_reactivated_with_backdating", "subscription_renewed", "subscription_items_renewed", "subscription_scheduled_cancellation_removed", "subscription_changes_scheduled", "subscription_scheduled_changes_removed", "subscription_shipping_address_updated", "subscription_deleted", "subscription_paused", "subscription_pause_scheduled", "subscription_scheduled_pause_removed", "subscription_resumed", "subscription_resumption_scheduled", "subscription_scheduled_resumption_removed", "subscription_advance_invoice_schedule_added", "subscription_advance_invoice_schedule_updated", "subscription_advance_invoice_schedule_removed", "pending_invoice_created", "pending_invoice_updated", "invoice_generated", "invoice_generated_with_backdating", "invoice_updated", "invoice_deleted", "credit_note_created", "credit_note_created_with_backdating", "credit_note_updated", "credit_note_deleted", "einvoice_created", "einvoice_updated", "subscription_renewal_reminder", "transaction_created", "transaction_updated", "transaction_deleted", "payment_succeeded", "payment_failed", "dunning_updated", "payment_refunded", "payment_initiated", "refund_initiated", "authorization_succeeded", "authorization_voided", "card_added", "card_updated", "card_expiry_reminder", "card_expired", "card_deleted", "payment_source_added", "payment_source_updated", "payment_source_deleted", "payment_source_expiring", "payment_source_expired", "payment_source_locally_deleted", "virtual_bank_account_added", "virtual_bank_account_updated", "virtual_bank_account_deleted", "token_created", "token_consumed", "token_expired", "unbilled_charges_created", "unbilled_charges_voided", "unbilled_charges_deleted", "unbilled_charges_invoiced", "order_created", "order_updated", "order_cancelled", "order_delivered", "order_returned", "order_ready_to_process", "order_ready_to_ship", "order_deleted", "order_resent", "quote_created", "quote_updated", "quote_deleted", "tax_withheld_recorded", "tax_withheld_deleted", "tax_withheld_refunded", "gift_scheduled", "gift_unclaimed", "gift_claimed", "gift_expired", "gift_cancelled", "gift_updated", "hierarchy_created", "hierarchy_deleted", "payment_intent_created", "payment_intent_updated", "contract_term_created", "contract_term_renewed", "contract_term_terminated", "contract_term_completed", "contract_term_cancelled", "voucher_created", "voucher_expired", "voucher_create_failed", "subscription_ramp_created", "subscription_ramp_deleted", "subscription_ramp_applied", "subscription_ramp_drafted", "subscription_ramp_updated", "subscription_moved_in", "subscription_moved_out", "subscription_movement_failed", "omnichannel_subscription_created", "omnichannel_subscription_item_renewed", "omnichannel_subscription_item_downgraded", "omnichannel_subscription_item_expired", "omnichannel_subscription_item_cancellation_scheduled", "omnichannel_subscription_item_scheduled_cancellation_removed", "omnichannel_subscription_item_resubscribed", "omnichannel_subscription_item_upgraded", "omnichannel_subscription_item_cancelled", "omnichannel_subscription_imported", "omnichannel_subscription_item_grace_period_started", "omnichannel_subscription_item_grace_period_expired", "omnichannel_subscription_item_dunning_started", "omnichannel_subscription_item_dunning_expired", "rule_created", "rule_updated", "rule_deleted", "record_purchase_failed", "omnichannel_subscription_item_change_scheduled", "omnichannel_subscription_item_scheduled_change_removed", "omnichannel_subscription_item_reactivated", "sales_order_created", "sales_order_updated", "omnichannel_subscription_item_changed", "omnichannel_subscription_item_paused", "omnichannel_subscription_item_resumed", "omnichannel_one_time_order_created", "omnichannel_one_time_order_item_cancelled", "omnichannel_subscription_item_pause_scheduled", "vault_token_created", "vault_token_updated", "vault_token_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.\n",
            "maxLength" : 60,
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "default" : "v1",
            "deprecated" : false,
            "description" : "The Chargebee API Version used for rendering this event content. While processing webhooks, ensure this version is same as the API version used by your webhook server's client library.\n\n* v1 - Chargebee API version V1\n* v2 - Chargebee API version V2\n",
            "enum" : [ "v1", "v2" ],
            "example" : null
          },
          "content" : {
            "type" : "object",
            "additionalProperties" : true,
            "deprecated" : false,
            "description" : "The JSON data associated with this event. Has resources (*subscription*\n, *invoice*\netc) based on the [event type](/docs/api/v2/pcv-1/events/event-types).\nThese resources are structured based on the Chargebee API version indicated by the *api_version*\nattribute.\n",
            "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`\nobject data is a queued operation and hence there can be an additional delay of up to 5 seconds.\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Uniquely identifies a webhook\n",
                  "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.\n* **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.\n\n* disabled - Disabled as no longer used\n* failed - Webhook call has been suspended after the all retries have resulted in failure.\n* succeeded - Webhook call was successful.\n* rate_limited - Webhook call was rate limited.\n* scheduled - Webhook call has been scheduled.\n* re_scheduled - Webhook call has been rescheduled due failure(s) in previous call(s)\n* not_applicable - Webhook call is not applicable for this event.\n* skipped - Skipped as specified in request\n* not_configured - Webhook was not configured when this event occurred\n",
                  "enum" : [ "not_configured", "scheduled", "succeeded", "re_scheduled", "failed", "skipped", "not_applicable", "disabled", "rate_limited" ],
                  "example" : null
                }
              },
              "required" : [ "id", "webhook_status" ],
              "example" : null
            },
            "example" : null
          }
        },
        "required" : [ "content", "id", "occurred_at", "source" ],
        "example" : null
      },
      "EventName" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "cancellation_page_loaded" ],
        "example" : null
      },
      "EventType" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "plan_created", "plan_updated", "plan_deleted", "addon_created", "addon_updated", "addon_deleted", "coupon_created", "coupon_updated", "coupon_deleted", "coupon_set_created", "coupon_set_updated", "coupon_set_deleted", "coupon_codes_added", "coupon_codes_deleted", "coupon_codes_updated", "customer_created", "customer_changed", "customer_deleted", "customer_moved_out", "customer_moved_in", "promotional_credits_added", "promotional_credits_deducted", "subscription_created", "subscription_created_with_backdating", "subscription_started", "subscription_trial_end_reminder", "subscription_activated", "subscription_activated_with_backdating", "subscription_changed", "subscription_trial_extended", "mrr_updated", "subscription_changed_with_backdating", "subscription_cancellation_scheduled", "subscription_cancellation_reminder", "subscription_cancelled", "subscription_canceled_with_backdating", "subscription_reactivated", "subscription_reactivated_with_backdating", "subscription_renewed", "subscription_items_renewed", "subscription_scheduled_cancellation_removed", "subscription_changes_scheduled", "subscription_scheduled_changes_removed", "subscription_shipping_address_updated", "subscription_deleted", "subscription_paused", "subscription_pause_scheduled", "subscription_scheduled_pause_removed", "subscription_resumed", "subscription_resumption_scheduled", "subscription_scheduled_resumption_removed", "subscription_advance_invoice_schedule_added", "subscription_advance_invoice_schedule_updated", "subscription_advance_invoice_schedule_removed", "pending_invoice_created", "pending_invoice_updated", "invoice_generated", "invoice_generated_with_backdating", "invoice_updated", "invoice_deleted", "credit_note_created", "credit_note_created_with_backdating", "credit_note_updated", "credit_note_deleted", "einvoice_created", "einvoice_updated", "subscription_renewal_reminder", "transaction_created", "transaction_updated", "transaction_deleted", "payment_succeeded", "payment_failed", "dunning_updated", "payment_refunded", "payment_initiated", "refund_initiated", "authorization_succeeded", "authorization_voided", "card_added", "card_updated", "card_expiry_reminder", "card_expired", "card_deleted", "payment_source_added", "payment_source_updated", "payment_source_deleted", "payment_source_expiring", "payment_source_expired", "payment_source_locally_deleted", "virtual_bank_account_added", "virtual_bank_account_updated", "virtual_bank_account_deleted", "token_created", "token_consumed", "token_expired", "unbilled_charges_created", "unbilled_charges_voided", "unbilled_charges_deleted", "unbilled_charges_invoiced", "order_created", "order_updated", "order_cancelled", "order_delivered", "order_returned", "order_ready_to_process", "order_ready_to_ship", "order_deleted", "order_resent", "quote_created", "quote_updated", "quote_deleted", "tax_withheld_recorded", "tax_withheld_deleted", "tax_withheld_refunded", "gift_scheduled", "gift_unclaimed", "gift_claimed", "gift_expired", "gift_cancelled", "gift_updated", "hierarchy_created", "hierarchy_deleted", "payment_intent_created", "payment_intent_updated", "contract_term_created", "contract_term_renewed", "contract_term_terminated", "contract_term_completed", "contract_term_cancelled", "voucher_created", "voucher_expired", "voucher_create_failed", "subscription_ramp_created", "subscription_ramp_deleted", "subscription_ramp_applied", "subscription_ramp_drafted", "subscription_ramp_updated", "subscription_moved_in", "subscription_moved_out", "subscription_movement_failed", "omnichannel_subscription_created", "omnichannel_subscription_item_renewed", "omnichannel_subscription_item_downgraded", "omnichannel_subscription_item_expired", "omnichannel_subscription_item_cancellation_scheduled", "omnichannel_subscription_item_scheduled_cancellation_removed", "omnichannel_subscription_item_resubscribed", "omnichannel_subscription_item_upgraded", "omnichannel_subscription_item_cancelled", "omnichannel_subscription_imported", "omnichannel_subscription_item_grace_period_started", "omnichannel_subscription_item_grace_period_expired", "omnichannel_subscription_item_dunning_started", "omnichannel_subscription_item_dunning_expired", "rule_created", "rule_updated", "rule_deleted", "record_purchase_failed", "omnichannel_subscription_item_change_scheduled", "omnichannel_subscription_item_scheduled_change_removed", "omnichannel_subscription_item_reactivated", "sales_order_created", "sales_order_updated", "omnichannel_subscription_item_changed", "omnichannel_subscription_item_paused", "omnichannel_subscription_item_resumed", "omnichannel_one_time_order_created", "omnichannel_one_time_order_item_cancelled", "omnichannel_subscription_item_pause_scheduled", "vault_token_created", "vault_token_updated", "vault_token_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.\n\nExport 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.\n\n**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.\n\n**Note:** Export operations are eventually consistent, so exported data might not reflect a recent write. For more information, see [Read consistency](/docs/api/v2/pcv-1/read-consistency).\n",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "A unique identifier to identify the export\n",
            "maxLength" : 50,
            "example" : null
          },
          "operation_type" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Describes the type of export\n",
            "maxLength" : 100,
            "example" : null
          },
          "mime_type" : {
            "type" : "string",
            "default" : "zip",
            "deprecated" : false,
            "description" : "Describes the mime type of download file\n\n* pdf - PDF\n* zip - ZIP\n",
            "enum" : [ "pdf", "zip" ],
            "example" : null
          },
          "status" : {
            "type" : "string",
            "default" : "in_process",
            "deprecated" : false,
            "description" : "Current status of the export operation\n\n* completed - Completed\n* failed - Failed\n* in_process - In Process\n",
            "enum" : [ "in_process", "completed", "failed" ],
            "example" : null
          },
          "created_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Export created time\n",
            "example" : null
          },
          "download" : {
            "type" : "object",
            "deprecated" : false,
            "description" : "Returns the download_url for the export. The download URL is valid upto a specific date.\n",
            "properties" : {
              "download_url" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The URL at which the file is available for download.\n",
                "maxLength" : 3500,
                "example" : null
              },
              "valid_till" : {
                "type" : "integer",
                "format" : "unix-time",
                "deprecated" : false,
                "description" : "The time until which the `download_url`\nis valid.\n",
                "example" : null
              },
              "mime_type" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The [media type](https://en.wikipedia.org/wiki/Media_type)\nof the file.\n",
                "maxLength" : 100,
                "example" : null
              }
            },
            "required" : [ "download_url", "valid_till" ],
            "example" : null
          }
        },
        "required" : [ "created_at", "id", "mime_type", "operation_type", "status" ],
        "example" : null
      },
      "ExportType" : {
        "type" : "string",
        "default" : "data",
        "deprecated" : false,
        "enum" : [ "data", "import_friendly_data" ],
        "example" : null
      },
      "FailedUsageEvent" : {
        "type" : "object",
        "properties" : {
          "subscription_id" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 50,
            "example" : null
          },
          "usage_timestamp" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 100,
            "example" : null
          },
          "ingestion_timestamp" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "example" : null
          },
          "properties" : {
            "type" : "string",
            "deprecated" : false,
            "example" : null
          },
          "error_codes" : {
            "type" : "array",
            "deprecated" : false,
            "items" : {
              "example" : null
            },
            "example" : null
          },
          "event_meta" : {
            "type" : "object",
            "additionalProperties" : true,
            "deprecated" : false,
            "example" : null
          }
        },
        "required" : [ "error_codes", "event_meta", "ingestion_timestamp", "properties", "subscription_id" ],
        "example" : null
      },
      "FeatureAvailabilityMetric" : {
        "type" : "object",
        "properties" : {
          "state" : {
            "type" : "string",
            "deprecated" : false,
            "enum" : [ "draft", "active", "archived", "deleted" ],
            "example" : null
          },
          "count" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "example" : null
          },
          "last_updated_at" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "example" : null
          }
        },
        "example" : null
      },
      "FreePeriodUnit" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "day", "week", "month", "year" ],
        "example" : null
      },
      "FriendOfferType" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "none", "coupon", "coupon_code" ],
        "example" : null
      },
      "FullExport" : {
        "type" : "object",
        "description" : "The Full Export API allows bulk download of various datasets from a secure location where data is loaded daily on a predefined schedule. Users can request dataset downloads by specifying the dataset name and date, among others. All the records of a given day (from 12:00 a.m. to 11:59 p.m. UTC) are available to query by the following day. The API responds with a download URL upon successful availability.\n",
        "properties" : {
          "table" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The name of the table from which the data has been exported. For example, invoices.\n",
            "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.\n\n* failed - When the export is failed.\n* completed - When the export is completed.\n* in_process - When the export is in process.\n",
            "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.\n",
            "example" : null
          },
          "created_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "A timestamp representing when the export was initiated. For example, 1693383422.\n",
            "example" : null
          },
          "download" : {
            "type" : "object",
            "deprecated" : false,
            "description" : "Returns the download_url for the export. The download URL is valid upto a specific date.\n",
            "properties" : {
              "download_url" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The URL at which the file is available for download.\n",
                "maxLength" : 3500,
                "example" : null
              },
              "valid_till" : {
                "type" : "integer",
                "format" : "unix-time",
                "deprecated" : false,
                "description" : "The time until which the `download_url`\nis valid.\n",
                "example" : null
              },
              "mime_type" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The [media type](https://en.wikipedia.org/wiki/Media_type)\nof the file. This gives information on the file format/type. For example, application/x-parquet.\n",
                "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\n",
            "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\n",
            "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\n",
            "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\n",
            "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\n",
            "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\n",
            "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\n",
            "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\n",
            "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\n",
            "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\n",
            "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\n",
            "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\n",
            "maxLength" : 100,
            "example" : null
          },
          "processor_error_message" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "This message describes the specific error that the payment processor encountered\n",
            "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.\n",
            "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.\n\nGift 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.\n\nIf the gift is not claimed before the claim_expiry_date, it will be moved to the '**expired**' state.\n\n#### GIFT SUBSCRIPTION\n\nGift subscriptions will be created in '**future** ' state. Once the gift is claimed, the subscription will be moved to '**non-renewing**' state.\n\n#### INVOICE\n\nGift 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.\n",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Uniquely identifies a gift\n",
            "maxLength" : 150,
            "example" : null
          },
          "status" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Status of the gift.\n\n* claimed - Gift is claimed.\n* cancelled - Gift is cancelled.\n* unclaimed - Gift is not yet claimed and is ready to be claimed.\n* scheduled - Gift has been scheduled.\n* expired - Gift is expired.\n",
            "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.\n",
            "example" : null
          },
          "auto_claim" : {
            "type" : "boolean",
            "default" : false,
            "deprecated" : false,
            "description" : "When `true`\n, the claim happens automatically. When not passed, the default value in the site settings is used.\n",
            "example" : null
          },
          "no_expiry" : {
            "type" : "boolean",
            "deprecated" : false,
            "description" : "When `true`\n, indicates that the gift does not expire. Do not pass or pass as `false`\nwhen `auto_claim`\nis set.\n",
            "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`.\nIf the gift is not claimed within `claim_expiry_date`\n, it will expire and the subscription will move to `cancelled`\nstate. When not passed, the value specified in the site settings will be used.\nPass as `NULL`\nor do not pass when `auto_claim`\nor `no_expiry`\nare set.\n",
            "example" : null
          },
          "resource_version" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Version number of this resource. The `resource_version`\nis 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.\n",
            "example" : null
          },
          "updated_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp indicating when this gift resource was last updated.\n",
            "example" : null
          },
          "gifter" : {
            "type" : "object",
            "deprecated" : false,
            "description" : "Gifter details\n",
            "properties" : {
              "customer_id" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Gifter customer id.\n",
                "maxLength" : 50,
                "example" : null
              },
              "invoice_id" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Invoice raised on the gifter.\n",
                "maxLength" : 50,
                "example" : null
              },
              "signature" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Gifter sign-off name\n",
                "maxLength" : 50,
                "example" : null
              },
              "note" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Personalized message for the gift.\n",
                "maxLength" : 500,
                "example" : null
              }
            },
            "required" : [ "customer_id" ],
            "example" : null
          },
          "gift_receiver" : {
            "type" : "object",
            "deprecated" : false,
            "description" : "Receiver details\n",
            "properties" : {
              "customer_id" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Receiver customer id.\n",
                "maxLength" : 50,
                "example" : null
              },
              "subscription_id" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Subscription created for the gift.\n",
                "maxLength" : 50,
                "example" : null
              },
              "first_name" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "First name of the receiver as given by the gifter.\n",
                "maxLength" : 150,
                "example" : null
              },
              "last_name" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Last name of the receiver as given by the gifter,\n",
                "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.\n",
                "maxLength" : 70,
                "example" : null
              }
            },
            "required" : [ "customer_id", "subscription_id" ],
            "example" : null
          },
          "gift_timelines" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "Gift timeline details\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "status" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Status of the gift.\n\n* cancelled - Gift is cancelled.\n* expired - Gift is expired.\n* scheduled - Gift has been scheduled.\n* claimed - Gift is claimed.\n* unclaimed - Gift is not yet claimed and is ready to be claimed.\n",
                  "enum" : [ "scheduled", "unclaimed", "claimed", "cancelled", "expired" ],
                  "example" : null
                },
                "occurred_at" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "Timestamp indicating when this event occurred.\n",
                  "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",
        "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" : [ "credit_unit" ],
            "example" : null
          },
          "account_type" : {
            "type" : "string",
            "deprecated" : false,
            "enum" : [ "provisioned", "overdraft" ],
            "example" : null
          },
          "effective_from" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "example" : null
          },
          "expires_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "example" : null
          },
          "origin_grant_block_id" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 50,
            "example" : null
          },
          "status" : {
            "type" : "string",
            "default" : "available",
            "deprecated" : false,
            "enum" : [ "available", "exhausted", "scheduled", "in_grace_period" ],
            "example" : null
          },
          "grant_source" : {
            "type" : "string",
            "deprecated" : false,
            "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,
            "example" : null
          },
          "modified_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "example" : null
          },
          "resource_version" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "example" : null
          },
          "metadata" : {
            "type" : "object",
            "additionalProperties" : true,
            "deprecated" : false,
            "example" : null
          },
          "provisioned_block_balance" : {
            "type" : "object",
            "deprecated" : false,
            "properties" : {
              "granted_amount" : {
                "type" : "string",
                "deprecated" : false,
                "maxLength" : 36,
                "example" : null
              },
              "total_balance" : {
                "type" : "string",
                "deprecated" : false,
                "maxLength" : 36,
                "example" : null
              },
              "usable_balance" : {
                "type" : "string",
                "deprecated" : false,
                "maxLength" : 36,
                "example" : null
              },
              "hold_amount" : {
                "type" : "string",
                "deprecated" : false,
                "maxLength" : 36,
                "example" : null
              },
              "used_amount" : {
                "type" : "string",
                "deprecated" : false,
                "maxLength" : 36,
                "example" : null
              },
              "expired_amount" : {
                "type" : "string",
                "deprecated" : false,
                "maxLength" : 36,
                "example" : null
              },
              "rolled_over_amount" : {
                "type" : "string",
                "deprecated" : false,
                "maxLength" : 36,
                "example" : null
              },
              "voided_amount" : {
                "type" : "string",
                "deprecated" : false,
                "maxLength" : 36,
                "example" : null
              }
            },
            "example" : null
          },
          "overdraft_block_balance" : {
            "type" : "object",
            "deprecated" : false,
            "properties" : {
              "is_unlimited" : {
                "type" : "boolean",
                "default" : false,
                "deprecated" : false,
                "example" : null
              },
              "limit" : {
                "type" : "string",
                "deprecated" : false,
                "maxLength" : 36,
                "example" : null
              },
              "total_balance" : {
                "type" : "string",
                "deprecated" : false,
                "maxLength" : 36,
                "example" : null
              },
              "usable_balance" : {
                "type" : "string",
                "deprecated" : false,
                "maxLength" : 36,
                "example" : null
              },
              "used_amount" : {
                "type" : "string",
                "deprecated" : false,
                "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
      },
      "Hierarchy" : {
        "type" : "object",
        "description" : "When a customer belongs to an [account hierarchy](https://www.chargebee.com/docs/1.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/v2/pcv-1/customers/get-hierarchy)\n* [Update hierarchy access settings](/docs/api/v2/pcv-1/customers/update-hierarchy-access-settings-for-a-customer)\n* [Link a customer to a hierarchy](/docs/api/v2/pcv-1/customers/link-a-customer)\n* [Delink a customer from a hierarchy](/docs/api/v2/pcv-1/customers/delink-a-customer)\n",
        "properties" : {
          "customer_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The `id`\nof the customer associated with this `hierarchy`\nresource.\n",
            "maxLength" : 50,
            "example" : null
          },
          "parent_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The `id`\nof the immediate parent for the customer identified by `customer_id`.\nIf the customer is the root of the hierarchy, this attribute isn't returned.\n",
            "maxLength" : 50,
            "example" : null
          },
          "payment_owner_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The `id`\nof the customer responsible for paying the invoices for the customer identified by `customer_id`.\nThis ID must match either `customer_id`\nor `invoice_owner_id`\n.\n",
            "maxLength" : 50,
            "example" : null
          },
          "invoice_owner_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The `id`\nof the customer who receives the invoice for charges incurred by the customer identified by `customer_id`.\nThis ID must match either `customer_id`\nor one of its ancestors.\n",
            "maxLength" : 50,
            "example" : null
          },
          "has_children" : {
            "type" : "boolean",
            "deprecated" : false,
            "description" : "Indicates whether the customer has child accounts in the hierarchy.\n",
            "example" : null
          },
          "children_ids" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "A list of `id`\ns representing the immediate children, if any exist, for the customer identified by `customer_id`\n.\n",
            "items" : {
              "type" : "string",
              "deprecated" : false,
              "maxLength" : 50,
              "example" : null
            },
            "example" : null
          }
        },
        "required" : [ "customer_id", "invoice_owner_id", "payment_owner_id" ],
        "example" : null
      },
      "HierarchyCreatedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              }
            },
            "required" : [ "customer" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "HierarchyDeletedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              }
            },
            "required" : [ "customer" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "HierarchyOperationType" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "complete_hierarchy", "subordinates", "path_to_root" ],
        "example" : null
      },
      "HostedPage" : {
        "type" : "object",
        "description" : "Hosted pages are the easiest and most secure way to integrate chargebee with your website. By using hosted pages, you can avoid the sensitive card information passing through your server and be compliant with most of the PCI DSS requirements.\n\nWhen you request for a hosted page, a **secure** and **unique URL** will be returned which you could either embed or redirect depending upon the embed parameter value that you had passed.\n\nSpecifying **\"embed\"** parameter as **true** allows you to embed the \"hosted page\" in an iframe in your own website. This helps you provide the best experience to your user as they do not have to leave your website to provide card information. There are a few limitations:\n\n* Your site URL must be embedded with HTTPS.\n* Set the appropriate height and width for the iframe to avoid scrolling.\n\nTo use the hosted pages, you must configure **Redirect URL** in the Chargebee web interface under **Hosted Pages Settings** \\> **Configuration**. The configured redirect URL will be called with the following parameters after user had submitted the page.\n\n* **id** - unique identifier of the hosted page resource\n* **state** - succeeded, failed or cancelled\n\nAfter the **Redirect URL** is called by Chargebee with the above parameters, the details of the hosted page can be fetched using [Retrieve a hosted page](/docs/api/v2/pcv-1/hosted_pages/retrieve-a-hosted-page) API. The **content** attribute will have the details about the customer, subscription, card and invoice based on the type of the hosted page.\n\n[Checkout New Subscription](/docs/api/v2/pcv-1/hosted_pages/checkout-new-subscription):\n\n* [Customer](/docs/api/customers/customer-object) - The details about the new customer created.\n* [Subscription](/docs/api/subscriptions/subscription-object) - The details about the new subscription created.\n* [Card](/docs/api/cards/card-object) - The details about the card provided while subscribing.\n* [Invoice](/docs/api/invoices/invoice-object) - The details about the invoice, if one is generated.\n\n[Checkout Existing Subscription](/docs/api/v2/pcv-1/hosted_pages/checkout-existing-subscription):\n\n* [Customer](/docs/api/customers/customer-object) - The updated details of the customer.\n* [Subscription](/docs/api/subscriptions/subscription-object) - The updated details of the subscription.\n* [Card](/docs/api/cards/card-object) - The details about the card provided while subscribing.\n* [Invoice](/docs/api/invoices/invoice-object) - The details about the invoice, if one is generated.\n\n[Manage Payment Sources](/docs/api/v2/pcv-1/hosted_pages/manage-payment-sources):\n\n* [Customer](/docs/api/customers/customer-object) - The details about the customer for whom the card was updated.\n* [Card](/docs/api/cards/card-object) - The details about the updated card. It will be present only if the type of payment method is card.\n\nWhen an embedded hosted page is cancelled by your end user, the **content** attribute will have the unmodified details of customer, subscription and card resources.\n",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Unique identifier generated for each hosted page requested.\n",
            "maxLength" : 70,
            "example" : null
          },
          "type" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Type of the requested hosted page.\n\n* accept_quote - Accept Quote\n* collect_now - Collect Unpaid Invoices for a Customer\n* checkout_gift - Checkout a gift subscription\n* checkout_new - Checkout new Subscription\n* extend_subscription - To extend a Subscription period\n* checkout_one_time - Checkout one time\n* view_voucher - View Details of a voucher\n* pre_cancel - This hosted page is used to help retain customers when they attempt to cancel their account or subscription.\n* manage_payment_sources - Manage Payments for a customer\n* checkout_existing - Checkout existing Subscription\n* claim_gift - Claim a gift subscription\n",
            "enum" : [ "checkout_new", "checkout_existing", "manage_payment_sources", "collect_now", "extend_subscription", "checkout_gift", "claim_gift", "checkout_one_time", "pre_cancel", "view_voucher", "accept_quote" ],
            "example" : null
          },
          "url" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Unique URL for the hosted page that will be included in your website.\n",
            "maxLength" : 250,
            "example" : null
          },
          "state" : {
            "type" : "string",
            "default" : "created",
            "deprecated" : false,
            "description" : "Indicating the current state of the hosted page resource.\n\n* acknowledged - Indicates the succeeded hosted page is acknowledged.\n* created - Indicates the hosted page is just created.\n* requested - Indicates the hosted page is requested by the website\n* cancelled - Indicates the page is cancelled by the end user after requesting it.\n* succeeded - Indicates the hosted page is successfully submitted by the user and response is sent to the return url.\n",
            "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.\nFor 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/v2/pcv-1/hosted_pages/checkout-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.\n",
            "maxLength" : 2048,
            "example" : null
          },
          "embed" : {
            "type" : "boolean",
            "default" : true,
            "deprecated" : false,
            "description" : "If true then hosted page formatted to be shown in iframe. If false, it is formatted to be shown as a separate page.\n\n**Note**\n: For [in-app](https://www.chargebee.com/docs/checkout-v3.html)\ncheckout, default is false.\n",
            "example" : null
          },
          "created_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Indicates when this hosted page url is generated.\n",
            "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.\nThe expiration period depends on the [type](/docs/api/v2/pcv-1/hosted_pages/hosted_page-object#type) of hosted page:\n\n* For `checkout_new`, `checkout_existing`, and `checkout_one_time`, the URL expires 3 hours after the page is created.\n* For `collect_now` and `manage_payment_sources`, the URL expires 5 days after creation.\n",
            "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. The value is always `in_app` for this API version.  \nApplicable only when `type` is `checkout_new`, `checkout_existing`, `checkout_one_time`, `manage_payment_sources`, `checkout_gift`, or `claim_gift`.\n\n* in_app - The hosted page is rendered in the in-app layout.\n* full_page - Not supported for this API version. Upgrade to the [latest](/docs/api/hosted_pages/hosted-page-object#layout) API version to use this 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.\nIf hosted page state is \"succeeded\", then the subscription, customer, card \\& invoice(optional) resources during checkout can be obtained.\nIf hosted page is state is \"cancelled\", then it will be empty i.e no information about checkout.\n",
            "example" : null
          },
          "updated_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp indicating when this hosted page was last updated.\n",
            "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`\nis updated with a new timestamp in milliseconds.\n",
            "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.\n[Learn more](https://www.chargebee.com/docs/abandoned-carts.html)\n",
            "example" : null
          },
          "business_entity_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity.  \n**Note**\n\n[Multiple Business Entities](/docs/api/getting-started) is a feature available only on Product Catalog 2.0.\n",
            "maxLength" : 50,
            "example" : null
          },
          "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.\n",
            "maxLength" : 50,
            "example" : null
          }
        },
        "required" : [ "content", "embed" ],
        "example" : null
      },
      "InAppSubscription" : {
        "type" : "object",
        "description" : "**Important:**\n\nThese APIs operate asynchronously. When you receive a successful response code from an API call, it indicates only the successful submission of your request, not the completion of the operation.\n\nUsing In-app Subscriptions, you can track subscriptions you sell and service via in-app purchase channels such as Apple's App Store and Google's Play Store. Call [this API](/docs/api/in_app_subscriptions/process-purchase-command) to notify Chargebee of new subscription purchases. Chargebee responds by creating corresponding subscriptions. You can make the API call directly from the client-side application or from your server. In the case of the Apple App Store and Google Play Store integration, you can also configure Chargebee to receive server notifications from [Apple](https://developer.apple.com/documentation/appstoreservernotifications) and [Google](https://developer.android.com/google/play/billing/rtdn-reference#sub) to keep subscriptions up-to-date.  \n**Note:**\n\nAfter creating a subscription in Chargebee using the [process purchase command](/docs/api/in_app_subscriptions/process-purchase-command) API, Chargebee manages it in real-time using notification events from [Apple](/docs/api/in_app_purchase_events) or [Google](/docs/api/in_app_purchase_events). To enable these notifications, generate a notification URL using these links - [Apple](https://www.chargebee.com/docs/2.0/mobile-app-store-product-iap.html#connection-keys_notification-url) and [Google](https://www.chargebee.com/docs/2.0/mobile-playstore-notifications.html) and configure it in their respective stores.  \n**In-app subscriptions are read-only**\n\nThe subscriptions created via the [Process Purchase Command API](/docs/api/in_app_subscriptions/process-purchase-command) are managed by Apple or Google in response to actions taken by your subscribers via their respective accounts. Chargebee only keeps track of these subscriptions: creating and modifying them in response to events happening against the original subscriptions. Consequently, these subscriptions cannot be modified by you via the Chargebee admin console or the [Subscriptions API](/docs/api/subscriptions).\n",
        "properties" : {
          "subscription_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The `id`\nof the [subscription](/docs/api/subscriptions/subscription-object#id)\nfor which the receipt was sent.\n",
            "maxLength" : 100,
            "example" : null
          },
          "customer_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The `id`\nof the [customer](/docs/api/customers/customer-object#id)\nobject to which the subscription belongs.\n",
            "maxLength" : 100,
            "example" : null
          },
          "plan_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The\n`plan_id`\nof the of the subscription.\n",
            "maxLength" : 100,
            "example" : null
          },
          "store_status" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The status of the subscription for the store\n\n* paused - When the subscription is paused.\n* in_trial - When the subscription is in trial.\n* active - When the subscription is active.\n* cancelled - When the subscription is cancelled.\n",
            "enum" : [ "in_trial", "active", "cancelled", "paused" ],
            "example" : null
          },
          "invoice_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The `id`\nof the invoice generated in Chargebee\n",
            "maxLength" : 100,
            "example" : null
          }
        },
        "required" : [ "subscription_id" ],
        "example" : null
      },
      "Invoice" : {
        "type" : "object",
        "additionalProperties" : true,
        "description" : "Invoices are statements containing charges, adjustments and any discounts for a subscription specific to a term. For every subscription a draft invoice (upcoming invoice) is used to track all the charges, credits and adjustments for the current term.\n\nGenerally, an invoice is closed at start of the next term. However, cancellation and other such operations on subscription may trigger premature closing. While closing the invoice, in addition to recurring charges, credits and coupons are applied to calculate the final amount that is due.\n\nWhen invoice is closed, an attempt to charge the credit card is made. If the payment succeeds, it is marked as **paid** . If the payment fails, the invoice is marked as **payment_due** and retry settings are taken into account. If no retry attempts are configured, the invoice is marked as **not_paid** . If the amount due is zero or negative, the invoice is immediately marked as **paid** and the balance if any is carried forward to the next term of the invoice.  \n**Note:**\nIf *consolidated invoicing*\nis enabled, the attribute *invoice.subscription_id*\nshould **not**\nbe used (as it will not be present if the invoice has lines from multiple subscriptions). Instead to know the related subscriptions, their [line_items](/docs/api/invoices/invoice-object#line_items)\n*subscription_id*\nattribute should be referred.\n",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The invoice number. Acts as a identifier for invoice and typically generated sequentially.\n",
            "maxLength" : 50,
            "example" : null
          },
          "customer_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The identifier of the customer this invoice belongs to.\n",
            "maxLength" : 50,
            "example" : null
          },
          "payment_owner" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Payment owner of an invoice\n",
            "maxLength" : 50,
            "example" : null
          },
          "subscription_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The identifier of the subscription this invoice belongs to.\n**Note** :\nWhen consolidated invoicing is enabled, you have to refer to [line_item\\`s](/docs/api/invoices/invoice-object#line_items)\n`subscription_id`\nto 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.\n",
            "maxLength" : 50,
            "example" : null
          },
          "recurring" : {
            "type" : "boolean",
            "default" : true,
            "deprecated" : false,
            "description" : "Boolean indicating whether this invoice belongs to a subscription\n",
            "example" : null
          },
          "status" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Current status of this invoice.\n\n* 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* pending -\n  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`.\n  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.\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",
            "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`\n, 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.\n",
            "example" : null
          },
          "due_date" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Due date of the invoice\n",
            "example" : null
          },
          "net_term_days" : {
            "type" : "integer",
            "format" : "int32",
            "default" : 0,
            "deprecated" : false,
            "description" : "Number of days within which the invoice has to be paid\n",
            "example" : null
          },
          "po_number" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Purchase Order Number for this invoice\n",
            "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)\n",
            "maxLength" : 20,
            "example" : null
          },
          "price_type" : {
            "type" : "string",
            "default" : "tax_exclusive",
            "deprecated" : false,
            "description" : "The price type of the invoice.\n\n* tax_exclusive - All amounts in the document are exclusive of tax.\n* tax_inclusive - All amounts in the document are inclusive of tax.\n",
            "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.\n",
            "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.\n\nFor 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.\n",
            "maximum" : 1000000000,
            "minimum" : 0.0000000010,
            "example" : null
          },
          "currency_code" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The currency code (ISO 4217 format) for the invoice\n",
            "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.\n",
            "maxLength" : 3,
            "example" : null
          },
          "tax" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Total tax amount for this invoice\n",
            "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`\n\n* the sum of all [line_item_discounts[]](/docs/api/invoices/invoice-object#line_item_discounts)`.discount_amount`.\n",
            "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.\n",
            "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.\n",
            "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.\n",
            "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)\n\n* [amount_paid](/docs/api/invoices/invoice-object#amount_paid)\n* sum of [applied_credits](/docs/api/invoices/invoice-object#applied_credits)`.applied_amount`\n* sum of [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)`.cn_total`\n* sum of [linked_taxes_withheld](/docs/api/invoices/invoice-object#linked_taxes_withheld)`.amount`.\n",
            "minimum" : 0,
            "example" : null
          },
          "amount_adjusted" : {
            "type" : "integer",
            "format" : "int64",
            "default" : 0,
            "deprecated" : false,
            "description" : "Total adjustments made against this invoice.\n",
            "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`\nfor all `linked_payments[]`\nthat have `txn_status`\nas `success`.\n",
            "minimum" : 0,
            "example" : null
          },
          "paid_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp indicating the date \\& time this invoice got paid.\n",
            "example" : null
          },
          "write_off_amount" : {
            "type" : "integer",
            "format" : "int64",
            "default" : 0,
            "deprecated" : false,
            "description" : "Amount written off against this invoice.\n",
            "minimum" : 0,
            "example" : null
          },
          "credits_applied" : {
            "type" : "integer",
            "format" : "int64",
            "default" : 0,
            "deprecated" : false,
            "description" : "Total credits applied against this invoice.\n",
            "minimum" : 0,
            "example" : null
          },
          "dunning_status" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Current dunning status of the invoice.\n\n* exhausted - Maximum number of attempts have been made.\n* stopped - Dunning has stopped for this invoice.\n* success - Payment successfully collected during dunning process.\n* in_progress - Dunning is still in progress.\n",
            "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.\n",
            "example" : null
          },
          "voided_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp indicating the date \\& time this invoice got voided.\n",
            "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`\nis updated with a new timestamp in milliseconds.\n",
            "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.\n**Note** :\nThis value does not change when the following attributes are changed: *next_retry_at, dunning_status, has_advance_charges*\n",
            "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.\n",
            "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`\nis `true`\n, this attribute is the same as total. However, when the invoice is a [consolidated](https://www.chargebee.com/docs/2.0/consolidated-invoicing.html )\none, then it is the sum of all `line_items.amount`\nbelonging to a new.\n",
            "minimum" : 0,
            "example" : null
          },
          "has_advance_charges" : {
            "type" : "boolean",
            "deprecated" : false,
            "description" : "Boolean indicating any advance charge is present in this invoice.\n",
            "example" : null
          },
          "term_finalized" : {
            "type" : "boolean",
            "default" : true,
            "deprecated" : false,
            "description" : "Boolean indicating this invoice line_items terms are finalized or not.\n",
            "example" : null
          },
          "is_gifted" : {
            "type" : "boolean",
            "default" : false,
            "deprecated" : false,
            "description" : "Boolean indicating this invoice is gifted or not.\n",
            "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`\nbecomes any one of the following for the first time: `payment_due`\n, `posted`\n, or `paid`.\nFor an invoice with `status`\nas `pending`\n, this happens when it gets closed.\n",
            "example" : null
          },
          "expected_payment_date" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "The date and time at which [dunning](https://www.chargebee.com/docs/payments/2.0/dunning-v2.html) should resume automatically for the invoice. This attribute is present only if dunning is currently [paused](/docs/api/v2/pcv-1/invoices/pause-dunning-for-invoice) for the invoice.\n**See also** : [Dunning resumption process](/docs/api/v2/pcv-1/invoices/resume-dunning-for-invoice).\n",
            "example" : null
          },
          "amount_to_collect" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Payments that are yet to be collected for the invoice. This is the same value as [amount_due](/docs/api/invoices/invoice-object#amount_due)\n\n* the sum of [linked_payments[]](/docs/api/invoices/invoice-object#linked_payments)`.txn_amount` for all `linked_payments[]` that have `txn_status` as `in_progress`.\n",
            "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`.\nIf there is no `round-off amount`\n, it will display `0`\n.\n",
            "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**.\nMust be passed if set as mandatory in the app. The codes are case-sensitive\n",
            "maxLength" : 100,
            "example" : null
          },
          "deleted" : {
            "type" : "boolean",
            "deprecated" : false,
            "description" : "Indicates that this resource has been deleted.\n",
            "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.\n",
            "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).\nOnly applicable specifically for customers with [billing_address](/docs/api/customers/customer-object#billing_address)\n\n`country`\nas `XI`\n(which is **United Kingdom - Northern Ireland**\n).\n\nWhen you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\nin 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\nthe Brexit configuration, you have the option of setting [billing_address](/docs/api/customers/customer-object#billing_address)\n\n`country`\nas `XI`.\nThat's the code for **United Kingdom - Northern Ireland** .\nThe first two characters of the VAT number in such a case is\n`XI`\nby default. However, if the VAT number was registered in UK, the value should be `GB`.\nSet\n`vat_number_prefix`\nto `GB`\nfor such cases.\n",
            "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 ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity.  \n**Note**\n\n[Multiple Business Entities](/docs/api/getting-started) is a feature available only on Product Catalog 2.0.\n",
            "maxLength" : 50,
            "example" : null
          },
          "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.\n",
            "maxLength" : 50,
            "example" : null
          },
          "exchange_rates" : {
            "type" : "array",
            "deprecated" : false,
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "currency_code" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 3,
                  "example" : null
                },
                "rate" : {
                  "type" : "number",
                  "format" : "decimal",
                  "deprecated" : false,
                  "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\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Uniquely identifies a line_item\n",
                  "maxLength" : 40,
                  "example" : null
                },
                "subscription_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "A unique identifier for the subscription this line item belongs to.\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "date_from" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "Start date of this line item.\n",
                  "example" : null
                },
                "date_to" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "End date of this line item.\n",
                  "example" : null
                },
                "unit_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Unit amount of the line item.\n",
                  "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.\nFor metered line items, this value is updated from [usages](/docs/api/usages) when:\n\n* the invoice is generated as pending\n\n* the invoice is [closed](/docs/api/invoices/close-a-pending-invoice)\n\n* the sync usages API is called\n\n",
                  "example" : null
                },
                "amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Total amount of this line item. Typically equals to unit amount x quantity\n",
                  "example" : null
                },
                "pricing_model" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The [pricing scheme](https://www.chargebee.com/docs/plans.html#pricing-attributes_pricing-model)\nfor this item.\n\n* per_unit - A fixed price per unit quantity.\n* volume - The per unit price is based on the tier that the total quantity falls in.\n* stairstep - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.\n* flat_fee - A fixed price that is not quantity-based.\n* tiered - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.\n",
                  "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\n",
                  "example" : null
                },
                "tax_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "default" : 0,
                  "deprecated" : false,
                  "description" : "The tax amount charged for this item\n",
                  "minimum" : 0,
                  "example" : null
                },
                "tax_rate" : {
                  "type" : "number",
                  "format" : "double",
                  "deprecated" : false,
                  "description" : "Rate of tax used to calculate tax for this lineitem\n",
                  "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`.\nThe value is in major units of the currency. Returned when the `line_item`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "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`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "maxLength" : 33,
                  "example" : null
                },
                "amount_in_decimal" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The decimal representation of the amount for the `line_item`\n, in major units of the currency. Typically equals to `unit_amount_in_decimal`\nx `quantity_in_decimal`.\nReturned when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "maxLength" : 39,
                  "example" : null
                },
                "discount_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Total discounts for this line\n",
                  "minimum" : 0,
                  "example" : null
                },
                "item_level_discount_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Line Item-level discounts for this line.\n",
                  "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.\n",
                  "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\n",
                  "maxLength" : 40,
                  "example" : null
                },
                "description" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Detailed description about this line item.\n",
                  "maxLength" : 250,
                  "example" : null
                },
                "entity_description" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Detailed description about this item.\n",
                  "maxLength" : 2000,
                  "example" : null
                },
                "entity_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Specifies the modelled entity this line item is based on.\n\n* adhoc - Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case\n* addon -\n  Indicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the [addon](/docs/api/v2/pcv-1/addons/addon-object)\n  id\n* plan -\n  Indicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)\n  id\n* plan_setup -\n  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)\n  id\n",
                  "enum" : [ "plan_setup", "plan", "addon", "adhoc" ],
                  "example" : null
                },
                "tax_exempt_reason" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The reason due to which the line item price/amount is exempted from tax.\n\n* tax_not_configured - If tax is not enabled for the site\n* tax_not_configured_external_provider - If the tax is not configured for the country in 3rd party tax provider.\n* customer_exempt - If the Customer is marked as Tax exempt\n* 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\n* product_exempt - If the Plan or Addon is marked as Tax exempt\n* 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.\n* reverse_charge - If the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU only\n* 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\n* zero_rated - If the rate of tax is 0% and no Sales/ GST tax is collectable for that line item\n* export -\n  You are not registered for tax in the customer's region. This is also the reason code when both `billing_address`\n  and `shipping_address`\n  have not been provided for the customer and subscription respectively\n",
                  "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\n",
                  "maxLength" : 100,
                  "example" : null
                },
                "customer_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "A unique identifier for the customer this line item belongs to\n",
                  "maxLength" : 100,
                  "example" : null
                },
                "proration_mode" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Proration mode for the line item.\n",
                  "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\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "line_item_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Uniquely identifies a line_item\n",
                  "maxLength" : 40,
                  "example" : null
                },
                "starting_unit" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "description" : "The lower limit of a range of units for the tier\n",
                  "minimum" : 0,
                  "example" : null
                },
                "ending_unit" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "description" : "The upper limit of a range of units for the tier\n",
                  "example" : null
                },
                "quantity_used" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "description" : "The number of units purchased in a range.\n",
                  "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`\npricing , or the price of each unit in the tier if the charge model is `tiered`\n/`volume`\npricing.\n",
                  "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`\nof the next lower tier. Returned only when the `line_items.pricing_model`\nis `tiered`\n, `volume`\nor `stairstep`\nand [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "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`\nof the next higher tier. Returned only when the `line_items.pricing_model`\nis `tiered`\n, `volume`\nor stairstep and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "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`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "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`\nis `tiered`\nor `volume`.\nWhen the `pricing_model`\nis `stairstep`\n, it is the decimal representation of the total price for `line_item`.\nThe value is in major units of the currency. Returned when the `line_item`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "maxLength" : 40,
                  "example" : null
                },
                "pricing_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "enum" : [ "per_unit", "flat_fee", "package" ],
                  "example" : null
                },
                "package_size" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "minimum" : 1,
                  "example" : null
                }
              },
              "required" : [ "quantity_used", "starting_unit", "unit_amount" ],
              "example" : null
            },
            "example" : null
          },
          "line_item_discounts" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "The list of deduction(s) applied for each line item of this invoice\n",
            "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.\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "discount_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The type of deduction and the amount to which it is applied.\n\n* prorated_credits -\n  The deduction is due to a legacy adjustment credit applied to the invoice. The `entity_id`\n  is `null`\n  in this case. The legacy credits feature is superseded by [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)\n  .\n* promotional_credits -\n  The deduction is due to a [promotional credit](/docs/api/promotional_credits)\n  applied to the invoice. The `entity_id`\n  is `null`\n  in this case.\n* document_level_coupon -\n  The deduction is due to a coupon applied to the invoice `sub_total`.\n  The coupon `id`\n  is available as `entity_id`\n  .\n* item_level_coupon -\n  The deduction is due to a coupon applied to a line item of the invoice. The coupon `id`\n  is available as `entity_id`\n  .\n",
                  "enum" : [ "item_level_coupon", "document_level_coupon", "promotional_credits", "prorated_credits" ],
                  "example" : null
                },
                "coupon_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "When the deduction is due to a coupon, then this is the id of the coupon.\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "entity_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 50,
                  "example" : null
                },
                "discount_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "The amount deducted. The format of this value depends on the [kind of currency](/docs/api/currencies)\n.\n",
                  "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\n",
            "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\n",
                  "maxLength" : 40,
                  "example" : null
                },
                "tax_name" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The name of the tax applied\n",
                  "maxLength" : 100,
                  "example" : null
                },
                "tax_rate" : {
                  "type" : "number",
                  "format" : "double",
                  "default" : 0,
                  "deprecated" : false,
                  "description" : "The rate of tax used to calculate tax amount\n",
                  "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.\n",
                  "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.\n",
                  "example" : null
                },
                "prorated_taxable_amount" : {
                  "type" : "number",
                  "format" : "decimal",
                  "deprecated" : false,
                  "description" : "Indicates the prorated line item amount in cents.\n",
                  "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.\n",
                  "example" : null
                },
                "is_non_compliance_tax" : {
                  "type" : "boolean",
                  "deprecated" : false,
                  "description" : "Indicates the non-compliance tax that should not be reported to the.\n",
                  "example" : null
                },
                "taxable_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Indicates the actual portion of the line item amount that is taxable.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "tax_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "The tax amount\n",
                  "minimum" : 0,
                  "example" : null
                },
                "tax_juris_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The type of tax jurisdiction\n\n* federal - The tax jurisdiction is a federal\n* state - The tax jurisdiction is a state\n* city - The tax jurisdiction is a city\n* special - Special tax jurisdiction.\n* unincorporated - Combined tax of state and county.\n* county - The tax jurisdiction is a county\n* country - The tax jurisdiction is a country\n* other - Jurisdictions other than the ones listed above.\n",
                  "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\n",
                  "maxLength" : 250,
                  "example" : null
                },
                "tax_juris_code" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The tax jurisdiction code\n",
                  "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.\n",
                  "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.\n",
                  "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.\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "cn_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The ID of the credit note from which this credit is applied.\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "applied_amount" : {
                  "type" : "number",
                  "format" : "double",
                  "default" : 0,
                  "deprecated" : false,
                  "description" : "The credit amount applied to the line item.\n",
                  "example" : null
                },
                "line_item_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The unique ID of the line item to which this credit is applied.\n",
                  "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.\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "line_item_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Line item reference\n",
                  "maxLength" : 40,
                  "example" : null
                },
                "first_name" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "First name of the customer\n",
                  "maxLength" : 150,
                  "example" : null
                },
                "last_name" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Last name of the customer\n",
                  "maxLength" : 150,
                  "example" : null
                },
                "email" : {
                  "type" : "string",
                  "format" : "email",
                  "deprecated" : false,
                  "description" : "Email address of the customer\n",
                  "maxLength" : 70,
                  "example" : null
                },
                "company" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Name of the company\n",
                  "maxLength" : 250,
                  "example" : null
                },
                "phone" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Phone number of the customer\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "line1" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Address line 1\n",
                  "maxLength" : 150,
                  "example" : null
                },
                "line2" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Address line 2\n",
                  "maxLength" : 150,
                  "example" : null
                },
                "line3" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Address line 3\n",
                  "maxLength" : 150,
                  "example" : null
                },
                "city" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Name of the city\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "state" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "State or Province\n",
                  "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).\nEntering 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)\n.\n",
                  "maxLength" : 20,
                  "example" : null
                },
                "validation_status" : {
                  "type" : "string",
                  "default" : "not_validated",
                  "deprecated" : false,
                  "description" : "The address verification status.\n\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n* valid - Address was validated successfully.\n",
                  "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.\n",
            "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)\n.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "description" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Description for this deduction.\n",
                  "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]`\nis `item_level_coupon`\nor `document_level_coupon`\n.\n",
                  "maxLength" : 40,
                  "example" : null
                },
                "entity_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The type of deduction and the amount to which it is applied.\n\n* prorated_credits -\n  The deduction is due to a legacy adjustment credit applied to the invoice. The `entity_id`\n  is `null`\n  in this case. The legacy credits feature is superseded by [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)\n  .\n* promotional_credits -\n  The deduction is due to a [promotional credit](/docs/api/promotional_credits)\n  applied to the invoice.\n* item_level_coupon -\n  The deduction is due to a coupon applied to line item. The coupon `id`\n  is passed as `entity_id`\n  .\n* document_level_coupon -\n  The deduction is due to a coupon applied to the invoice `sub_total`.\n  The coupon id is passed as `entity_id`\n  .\n",
                  "enum" : [ "item_level_coupon", "document_level_coupon", "promotional_credits", "prorated_credits" ],
                  "example" : null
                },
                "discount_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "enum" : [ "fixed_amount", "percentage" ],
                  "example" : null
                },
                "entity_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "When the deduction is due to a `coupon`\n, then this is the `id`\nof the coupon.\n",
                  "maxLength" : 100,
                  "example" : null
                },
                "coupon_set_code" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The [coupon code](/docs/api/coupon_codes/coupon_code-object#code)\n, if applicable, used to provide the discount. The [coupon.id](/docs/api/coupons/coupon-object#id)\nis available in `entity_id`\n.\n",
                  "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\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "name" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The name of the tax applied. E.g. GST.\n",
                  "maxLength" : 100,
                  "example" : null
                },
                "amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "The tax amount.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "description" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Description of the tax item.\n",
                  "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.\n",
            "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)\n) where the tax originated from.\n",
                "maxLength" : 50,
                "example" : null
              },
              "registration_number" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "It represents the tax registration number for the entity used to collect tax.\n",
                "maxLength" : 100,
                "example" : null
              }
            },
            "example" : null
          },
          "linked_taxes_withheld" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "Details of `tax_withheld`\nagainst this invoice.\n",
            "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_`.\nFor example, `tax_wh_16BdDXSlbu4uV1Ee6`\n.\n",
                  "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)\n.\n",
                  "minimum" : 1,
                  "example" : null
                },
                "description" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The description for this tax withheld.\n",
                  "maxLength" : 65000,
                  "example" : null
                },
                "date" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "Date or time associated with the tax withheld.\n",
                  "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.\n",
                  "maxLength" : 100,
                  "example" : null
                }
              },
              "required" : [ "id" ],
              "example" : null
            },
            "example" : null
          },
          "linked_payments" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "The list of transactions for this invoice\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "txn_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Uniquely identifies the transaction.\n",
                  "maxLength" : 40,
                  "example" : null
                },
                "applied_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "The transaction amount applied to this invoice\n",
                  "minimum" : 0,
                  "example" : null
                },
                "applied_at" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "Timestamp at which the transaction is applied.\n",
                  "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/v2/pcv-1/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/v2/pcv-1/transactions/transaction-object#status)\n  transaction to be reconciled at par with the gateway.  \n  [Learn more](https://www.chargebee.com/docs/payments/1.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.\n",
                  "example" : null
                },
                "txn_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Total amount of the transaction\n",
                  "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.\n",
            "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.\n",
                  "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.\n",
                  "example" : null
                },
                "txn_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The unique identifier for the transaction.\n",
                  "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.\n",
                  "example" : null
                },
                "txn_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "The total amount of the transaction.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "txn_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The type of transaction.\n\n* authorization -\n  The transaction is an authorization to capture the [amount](/docs/api/transactions/transaction-object#amount)\n  from the customer's [payment_source](/docs/api/payment_sources)\n  .\n* refund -\n  The transaction is a refund that returns the [amount](/docs/api/transactions/transaction-object#amount)\n  to the customer's [payment_source](/docs/api/payment_sources)\n  .\n* payment -\n  The transaction is a payment that captures the [amount](/docs/api/transactions/transaction-object#amount)\n  from the customer's [payment_source](/docs/api/payment_sources)\n  .\n* payment_reversal - The transaction is a reversal of a previously captured payment.\n",
                  "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`\nthat is yet to be captured. The payment capture is recorded as a transaction of `type`\n= `payment`.\nApplicable only for a transaction of `type`\n= `authorization`\n.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "authorization_reason" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Type of reason for the authorization transaction.\n\n* verification - The transaction was created to verify the payment method.\n* blocking_funds - The transaction was created to block funds from the payment method.\n* scheduled_capture -\n  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](/docs/api/invoices/invoice-object#linked_payments)\n  .\n",
                  "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\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "attempt" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "description" : "Dunning attempt number.\n",
                  "example" : null
                },
                "transaction_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Transaction associated with attempt.\n",
                  "maxLength" : 40,
                  "example" : null
                },
                "dunning_type" : {
                  "type" : "string",
                  "default" : "auto_collect",
                  "deprecated" : false,
                  "description" : "Types of dunning\n\n* offline - Dunning type is offline.\n* direct_debit - Dunning type is direct debit.\n* auto_collect - Dunning type is auto collection.\n",
                  "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.\n",
                  "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/v2/pcv-1/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/v2/pcv-1/transactions/transaction-object#status)\n  transaction to be reconciled at par with the gateway.  \n  [Learn more](https://www.chargebee.com/docs/payments/1.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\n",
                  "minimum" : 0,
                  "example" : null
                },
                "retry_engine" : {
                  "type" : "string",
                  "default" : "chargebee",
                  "deprecated" : false,
                  "description" : "The payment retry system used for this dunning attempt.\n\n* chargebee - The attempt was processed by Chargebee Recovery.\n* flexpay - The attempt was processed by FlexPay Recovery.\n* successplus - GoCardless Success Plus.\n",
                  "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.\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "cn_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Credit applied on the credit note ID.\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "applied_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Total credit amount applied to this invoice.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "applied_at" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "Time when the credit amount applied to this invoice.\n",
                  "example" : null
                },
                "cn_reason_code" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Credit note reason code. Deprecated; use the cn_create_reason_code parameter instead\n\n* other - Can be set when none of the above reason codes are applicable\n* order_cancellation - Order Cancellation\n* product_unsatisfactory - Product Unsatisfactory\n* chargeback - Can be set when you are recording your customer Chargebacks\n* subscription_cancellation - This reason will be set automatically for Credit Notes created during cancel subscription operation\n* fraudulent - FRAUDULENT\n* subscription_pause - This reason will be automatically set to credit notes created during pause/resume subscription operation.\n* service_unsatisfactory - Service Unsatisfactory\n* subscription_change -\n  This reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html)\n  is enabled\n* write_off -\n  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)\n  operation.\n* order_change - Order Change\n* waiver - Waiver\n",
                  "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\n",
                  "maxLength" : 100,
                  "example" : null
                },
                "cn_date" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "Indicates the date at which this credit note is created\n",
                  "example" : null
                },
                "cn_status" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Credit note status.\n\n* voided - When the Credit Note has been cancelled.\n* adjusted - When the Credit Note has been adjusted against an invoice.\n* refund_due - When the credits are yet to be used, or have been partially used.\n* refunded - When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded).\n",
                  "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.\n\n* pre_tax - Credits are applied before tax calculation.\n* post_tax - Credits are applied after tax calculation.\n",
                  "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\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "cn_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Credit-note id\n",
                  "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\n\n* subscription_cancellation - This reason will be set automatically for Credit Notes created during cancel subscription operation\n* waiver - Waiver\n* write_off -\n  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)\n  operation.\n* service_unsatisfactory - Service Unsatisfactory\n* fraudulent - FRAUDULENT\n* product_unsatisfactory - Product Unsatisfactory\n* order_change - Order Change\n* subscription_change -\n  This reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html)\n  is enabled\n* order_cancellation - Order Cancellation\n* other - Can be set when none of the above reason codes are applicable\n* chargeback - Can be set when you are recording your customer Chargebacks\n* subscription_pause - This reason will be automatically set to credit notes created during pause/resume subscription operation.\n",
                  "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\n",
                  "maxLength" : 100,
                  "example" : null
                },
                "cn_date" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "Indicates the date at which this credit note is created\n",
                  "example" : null
                },
                "cn_total" : {
                  "type" : "integer",
                  "format" : "int64",
                  "default" : 0,
                  "deprecated" : false,
                  "description" : "Total amount of the credit note.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "cn_status" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Credit note status.\n\n* refunded - When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded).\n* voided - When the Credit Note has been cancelled.\n* refund_due - When the credits are yet to be used, or have been partially used.\n* adjusted - When the Credit Note has been adjusted against an invoice.\n",
                  "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\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "cn_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Credit-note id\n",
                  "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\n\n* fraudulent - FRAUDULENT\n* chargeback - Can be set when you are recording your customer Chargebacks\n* subscription_pause - This reason will be automatically set to credit notes created during pause/resume subscription operation.\n* order_change - Order Change\n* subscription_change -\n  This reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html)\n  is enabled\n* product_unsatisfactory - Product Unsatisfactory\n* write_off -\n  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)\n  operation.\n* subscription_cancellation - This reason will be set automatically for Credit Notes created during cancel subscription operation\n* service_unsatisfactory - Service Unsatisfactory\n* waiver - Waiver\n* order_cancellation - Order Cancellation\n* other - Can be set when none of the above reason codes are applicable\n",
                  "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\n",
                  "maxLength" : 100,
                  "example" : null
                },
                "cn_date" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "Indicates the date at which this credit note is created\n",
                  "example" : null
                },
                "cn_total" : {
                  "type" : "integer",
                  "format" : "int64",
                  "default" : 0,
                  "deprecated" : false,
                  "description" : "Total amount of the credit note.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "cn_status" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Credit note status.\n\n* refund_due - When the credits are yet to be used, or have been partially used.\n* adjusted - When the Credit Note has been adjusted against an invoice.\n* voided - When the Credit Note has been cancelled.\n* refunded - When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded).\n",
                  "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\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Uniquely identifies the order. It is the api identifier for the order\n",
                  "maxLength" : 40,
                  "example" : null
                },
                "document_number" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The order's serial number\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "status" : {
                  "type" : "string",
                  "default" : "new",
                  "deprecated" : false,
                  "description" : "The status of this order.\n\n* awaiting_shipment - The order has been picked up by an integration system, and synced to a shipping management platform\n* queued - Order is yet to be processed by any system, these are scheduled orders created by Chargebee\n* returned - The order has been returned after delivery.\n* complete - Order has been processed successfully. Applicable only if you are using Chargebee's legacy order management system\n* processing - Order is being processed. Applicable only if you are using Chargebee's legacy order management system\n* new - Order has been created. Applicable only if you are using Chargebee's legacy order management system.\n* shipped - The order has moved from order management system to a shipping system.\n* on_hold - The order is paused from being processed.\n* cancelled - Order has been cancelled. Applicable only if you are using Chargebee's legacy order management system\n* delivered - The order has been delivered to the customer.\n* partially_delivered - The order has been partially delivered to the customer.\n* voided - Order has been voided. Applicable only if you are using Chargebee's legacy order management system\n",
                  "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\n\n* system_generated - The order has been created by Chargebee automatically based on the preferences set by the user.\n* manual - The order has been created by the user using Chargebee's legacy order management system.\n",
                  "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.\n",
                  "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;\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "batch_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Unique id to identify a group of orders.\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "created_at" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "The time at which the order was created\n",
                  "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)\nthat appear on the invoice PDF sent to the customer. Notes that come from a specific resource related to the invoice have `entity_type`\nand `entity_id`\ndefined. There can be up to two notes in this array for which `entity_type`\nand `entity_id`\nare not defined:\n\n* **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).\n* **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.\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "note" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Actual note.\n",
                  "maxLength" : 65000,
                  "example" : null
                },
                "entity_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Unique identifier of the entity.\n",
                  "maxLength" : 100,
                  "example" : null
                },
                "entity_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Type of entity to which the note belongs.\n\n* subscription - Entity that represents a subscription of customer.\n* customer - Entity that represents a customer.\n* plan - Entity that represents a plan.\n* tax -\n  The note is configured as part of the [tax configuration](https://www.chargebee.com/docs/tax.html)\n  in Chargebee Billing.\n* addon_item_price - Indicates that this line item is based on addon Item Price\n* addon - Entity that represents an addon.\n* plan_item_price - Indicates that this line item is based on plan Item Price\n* coupon - Entity that represents a coupon.\n* charge_item_price - Indicates that this line item is based on charge Item Price\n",
                  "enum" : [ "plan", "addon", "coupon", "subscription", "customer", "plan_item_price", "addon_item_price", "charge_item_price", "tax" ],
                  "example" : null
                }
              },
              "required" : [ "note" ],
              "example" : null
            },
            "example" : null
          },
          "shipping_address" : {
            "type" : "object",
            "deprecated" : false,
            "description" : "Shipping address for the invoice.\n",
            "properties" : {
              "first_name" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The first name of the contact.\n",
                "maxLength" : 150,
                "example" : null
              },
              "last_name" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The last name of the contact.\n",
                "maxLength" : 150,
                "example" : null
              },
              "email" : {
                "type" : "string",
                "format" : "email",
                "deprecated" : false,
                "description" : "The email address.\n",
                "maxLength" : 70,
                "example" : null
              },
              "company" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The company name.\n",
                "maxLength" : 250,
                "example" : null
              },
              "phone" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The phone number.\n",
                "maxLength" : 50,
                "example" : null
              },
              "line1" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Address line 1\n",
                "maxLength" : 150,
                "example" : null
              },
              "line2" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Address line 2\n",
                "maxLength" : 150,
                "example" : null
              },
              "line3" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Address line 3\n",
                "maxLength" : 150,
                "example" : null
              },
              "city" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                "maxLength" : 50,
                "example" : null
              },
              "state" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The state/province name.\n",
                "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)\n.\n",
                "maxLength" : 20,
                "example" : null
              },
              "validation_status" : {
                "type" : "string",
                "default" : "not_validated",
                "deprecated" : false,
                "description" : "The address verification status.\n\n* not_validated - Address is not yet validated.\n* valid - Address was validated successfully.\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n",
                "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                "example" : null
              }
            },
            "example" : null
          },
          "billing_address" : {
            "type" : "object",
            "deprecated" : false,
            "description" : "Billing address for the invoice.\n",
            "properties" : {
              "first_name" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The first name of the billing contact.\n",
                "maxLength" : 150,
                "example" : null
              },
              "last_name" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The last name of the billing contact.\n",
                "maxLength" : 150,
                "example" : null
              },
              "email" : {
                "type" : "string",
                "format" : "email",
                "deprecated" : false,
                "description" : "The email address.\n",
                "maxLength" : 70,
                "example" : null
              },
              "company" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The company name.\n",
                "maxLength" : 250,
                "example" : null
              },
              "phone" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The phone number.\n",
                "maxLength" : 50,
                "example" : null
              },
              "line1" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Address line 1\n",
                "maxLength" : 150,
                "example" : null
              },
              "line2" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Address line 2\n",
                "maxLength" : 150,
                "example" : null
              },
              "line3" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Address line 3\n",
                "maxLength" : 150,
                "example" : null
              },
              "city" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                "maxLength" : 50,
                "example" : null
              },
              "state" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "State or Province\n",
                "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)\n.\n",
                "maxLength" : 20,
                "example" : null
              },
              "validation_status" : {
                "type" : "string",
                "default" : "not_validated",
                "deprecated" : false,
                "description" : "The address verification status.\n\n* valid - Address was validated successfully.\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* not_validated - Address is not yet validated.\n* invalid - Address is invalid.\n",
                "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                "example" : null
              }
            },
            "example" : null
          },
          "statement_descriptor" : {
            "type" : "object",
            "deprecated" : false,
            "description" : "Statement descriptor for the invoice.\n",
            "properties" : {
              "id" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Uniquely identifies a statement_descriptor\n",
                "maxLength" : 40,
                "example" : null
              },
              "descriptor" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Payment descriptor text\n",
                "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.\n",
            "properties" : {
              "id" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The unique `id`\nfor the e-invoice. This is auto-generated by Chargebee.\n",
                "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.\n",
                "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.\n\nIn the future, this field may be used to store similar reference numbers for other networks.\n",
                "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`\n, see `message`\n.\n\n* under_query - The receiving entity has raised a query regarding the e-invoice. Additional information or clarification is required before proceeding.\n* 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.\n* paid - The receiving entity has confirmed that the e-invoice has been paid.\n* skipped -\n  The e-invoice was not sent. This could be due to missing information or because the `entity_identifier`\n  is not registered on the e-invoicing network.\n* failed - The e-invoice was sent and there was an error due to which it was not delivered.\n* in_progress - The e-invoice has been sent and Chargebee is waiting for confirmation from the receiving entity.\n* message_acknowledgement - An acknowledgment confirming that the application response was successfully received by the receiving entity.\n* scheduled - Sending the e-invoice to the customer has been scheduled.\n* conditionally_accepted - The e-invoice has been accepted with conditions.\n* accepted - The e-invoice was sent and it was accepted by the receiving entity. The sending entity shall also accept the e-invoice.\n* success - The e-invoice has been successfully delivered to the customer.\n* in_process - The e-invoice is currently being processed by the receiving entity.\n* registered - The e-invoice was sent and there was an error due to which it was not delivered but got cleared in the IRP.\n",
                "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`\nis `skipped`\nor `failed`\n, this contains the reason or error details. The following are some valid examples:\n\n* Invoice successfully sent to customer via the e-invoicing network 9090:123456\n* Invoice successfully sent to customer via email id abc@acme.com\n",
                "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).\n",
                "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.\n",
            "properties" : {
              "timezone" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "It represents the timezone of the site at the time of entity creation.\n",
                "maxLength" : 50,
                "example" : null
              },
              "organization_address" : {
                "type" : "object",
                "additionalProperties" : true,
                "deprecated" : false,
                "description" : "It represents the address configured for the site during entity creation.\n",
                "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" : [ "plan_setup", "plan", "addon", "adhoc" ],
                  "example" : null
                },
                "tax_exempt_reason" : {
                  "type" : "string",
                  "deprecated" : false,
                  "enum" : [ "tax_not_configured", "region_non_taxable", "export", "customer_exempt", "product_exempt", "zero_rated", "reverse_charge", "high_value_physical_goods", "zero_value_item", "tax_not_configured_external_provider" ],
                  "example" : null
                },
                "entity_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 100,
                  "example" : null
                },
                "customer_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 100,
                  "example" : null
                },
                "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" ],
                  "example" : null
                },
                "coupon_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 50,
                  "example" : null
                },
                "entity_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 50,
                  "example" : null
                },
                "discount_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "minimum" : 0,
                  "example" : null
                }
              },
              "required" : [ "discount_amount", "discount_type", "line_item_id" ],
              "example" : null
            },
            "example" : null
          },
          "line_item_taxes" : {
            "type" : "array",
            "deprecated" : false,
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "line_item_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 40,
                  "example" : null
                },
                "tax_name" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 100,
                  "example" : null
                },
                "tax_rate" : {
                  "type" : "number",
                  "format" : "double",
                  "default" : 0,
                  "deprecated" : false,
                  "maximum" : 100,
                  "minimum" : 0,
                  "example" : null
                },
                "date_to" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "example" : null
                },
                "date_from" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "example" : null
                },
                "prorated_taxable_amount" : {
                  "type" : "number",
                  "format" : "decimal",
                  "deprecated" : false,
                  "maximum" : 1000000000,
                  "minimum" : -1000000000,
                  "example" : null
                },
                "is_partial_tax_applied" : {
                  "type" : "boolean",
                  "deprecated" : false,
                  "example" : null
                },
                "is_non_compliance_tax" : {
                  "type" : "boolean",
                  "deprecated" : false,
                  "example" : null
                },
                "taxable_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "minimum" : 0,
                  "example" : null
                },
                "tax_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "minimum" : 0,
                  "example" : null
                },
                "tax_juris_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "enum" : [ "country", "federal", "state", "county", "city", "special", "unincorporated", "other" ],
                  "example" : null
                },
                "tax_juris_name" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 250,
                  "example" : null
                },
                "tax_juris_code" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 250,
                  "example" : null
                },
                "tax_amount_in_local_currency" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "minimum" : 0,
                  "example" : null
                },
                "local_currency_code" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 3,
                  "example" : null
                }
              },
              "required" : [ "tax_amount", "tax_name", "tax_rate", "taxable_amount" ],
              "example" : null
            },
            "example" : null
          },
          "line_item_credits" : {
            "type" : "array",
            "deprecated" : false,
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "cn_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 50,
                  "example" : null
                },
                "applied_amount" : {
                  "type" : "number",
                  "format" : "double",
                  "default" : 0,
                  "deprecated" : false,
                  "example" : null
                },
                "line_item_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 40,
                  "example" : null
                }
              },
              "required" : [ "applied_amount", "cn_id" ],
              "example" : null
            },
            "example" : null
          },
          "line_item_addresses" : {
            "type" : "array",
            "deprecated" : false,
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "line_item_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 40,
                  "example" : null
                },
                "first_name" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 150,
                  "example" : null
                },
                "last_name" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 150,
                  "example" : null
                },
                "email" : {
                  "type" : "string",
                  "format" : "email",
                  "deprecated" : false,
                  "maxLength" : 70,
                  "example" : null
                },
                "company" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 250,
                  "example" : null
                },
                "phone" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 50,
                  "example" : null
                },
                "line1" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 150,
                  "example" : null
                },
                "line2" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 150,
                  "example" : null
                },
                "line3" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 150,
                  "example" : null
                },
                "city" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 50,
                  "example" : null
                },
                "state_code" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 50,
                  "example" : null
                },
                "state" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 50,
                  "example" : null
                },
                "country" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 50,
                  "example" : null
                },
                "zip" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 20,
                  "example" : null
                },
                "validation_status" : {
                  "type" : "string",
                  "default" : "not_validated",
                  "deprecated" : false,
                  "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                  "example" : null
                }
              },
              "example" : null
            },
            "example" : null
          },
          "discounts" : {
            "type" : "array",
            "deprecated" : false,
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "minimum" : 0,
                  "example" : null
                },
                "description" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 250,
                  "example" : null
                },
                "line_item_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 40,
                  "example" : null
                },
                "entity_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "enum" : [ "item_level_coupon", "document_level_coupon", "promotional_credits", "prorated_credits" ],
                  "example" : null
                },
                "discount_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "enum" : [ "fixed_amount", "percentage" ],
                  "example" : null
                },
                "entity_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 100,
                  "example" : null
                },
                "coupon_set_code" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 50,
                  "example" : null
                }
              },
              "required" : [ "amount", "entity_type" ],
              "example" : null
            },
            "example" : null
          },
          "taxes" : {
            "type" : "array",
            "deprecated" : false,
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "name" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 100,
                  "example" : null
                },
                "amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "minimum" : 0,
                  "example" : null
                },
                "description" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 250,
                  "example" : null
                }
              },
              "required" : [ "amount", "name" ],
              "example" : null
            },
            "example" : null
          }
        },
        "required" : [ "currency_code", "price_type", "recurring", "sub_total" ],
        "example" : null
      },
      "InvoiceGeneratedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "invoice" : {
                "$ref" : "#/components/schemas/Invoice"
              }
            },
            "required" : [ "invoice" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "InvoiceGeneratedWithBackdatingEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "invoice" : {
                "$ref" : "#/components/schemas/Invoice"
              }
            },
            "required" : [ "invoice" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "InvoiceUpdatedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "invoice" : {
                "$ref" : "#/components/schemas/Invoice"
              }
            },
            "required" : [ "invoice" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "ItemType" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "plan", "addon", "charge" ],
        "example" : null
      },
      "Layout" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "in_app", "full_page" ],
        "example" : null
      },
      "Level" : {
        "type" : "object",
        "description" : "This resource returns the entitlement level attributes.\n",
        "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`\ncan have entitlement levels named as `All weekdays`\n, `All days`\n, `40 hours per week`\nand so on.\n\nWhen not provided for `feature.type`\n`quantity`\nor `range`\n, this name is auto-generated as the space-separated concatenation of `levels[].value`\nand the pluralized version of `unit`.\nFor example, if `levels[].value`\nis `20`\nand `unit`\nis `user`\n, then `levels[].name`\nbecomes `20 users`\n.\n",
            "maxLength" : 100,
            "example" : null
          },
          "value" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The value denoting the entitlement level granted.\n\n* **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\".\n* **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`.\n* **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`.\n",
            "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.\n\n* 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.\n* When `type` is `range`: This attribute is `0` for the minimum value and `1` for the maximum value in the range.\n\nWhen not defined, it is assumed as the index of the `levels[]`\narray.\n",
            "example" : null
          },
          "is_unlimited" : {
            "type" : "boolean",
            "deprecated" : false,
            "description" : "When `type`\nis `quantity`\nor `range`\n, this attribute indicates whether the entitlement level corresponds to unlimited units of the feature. Possible values:\n\n* `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.`\n* `false`: The entitlement level does not correspond to unlimited units of the feature.\n",
            "example" : null
          }
        },
        "required" : [ "is_unlimited", "level", "value" ],
        "example" : null
      },
      "MeterType" : {
        "type" : "string",
        "deprecated" : true,
        "enum" : [ "simple", "compound" ],
        "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:**\nThese APIs operate asynchronously. When you receive a successful response code from an API call, it indicates only the successful submission of your request, not the completion of the operation.\n\nUsing 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.\n",
        "properties" : {
          "invoice_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The unique immutable identifier of the invoice imported in Chargebee for which the receipt was sent.\n",
            "maxLength" : 100,
            "example" : null
          },
          "customer_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The unique immutable identifier of the customer object to which the invoice belongs.\n",
            "maxLength" : 100,
            "example" : null
          },
          "charge_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The `id` of the non-recurring add-on.\n",
            "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.\n",
        "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.\n\n**Features of this object:**\n\n* Records fulfillment IDs for tracking and reference.\n* Captures status (`in_progress`, `completed`, `failed`).\n* Stores redirect/checkout URLs as needed.\n* Contains timestamps for creation, completion, or failure.\n* Includes error codes and messages for failure analysis.\n",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "ID of the fulfillment that was created.\n",
            "maxLength" : 50,
            "example" : null
          },
          "personalized_offer_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "ID of the personalized offer that was accepted.\n",
            "maxLength" : 50,
            "example" : null
          },
          "option_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "ID of the offer option that was selected by the user.\n",
            "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.\n\n* webhook - Chargebee triggers webhook and fulfillment is processed by merchant's system\n* email - Chargebee sends an email as configured in the Growth application and the fulfillment is processed by merchant's system\n* checkout - The offer fulfillment is processed using Chargebee hosted checkout\n* url_redirect - The offer fulfillment is processed by merchant's system\n* billing_update - The offer fulfillment is processed by Chargebee\n",
            "enum" : [ "billing_update", "checkout", "url_redirect", "webhook", "email" ],
            "example" : null
          },
          "status" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Current status of the offer fulfillment process.\n\n* in_progress - The offer fulfillment is underway (not yet completed).\n* 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.\n* failed -\n  The offer fulfillment failed. The `error object`\n  field will be present to provide more details in this case.\n",
            "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\n",
            "maxLength" : 250,
            "example" : null
          },
          "failed_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp when the fulfillment failed (present only when status = failed).\n",
            "example" : null
          },
          "created_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp when the fulfillment record was created.\n",
            "example" : null
          },
          "completed_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp when the fulfillment succeeded (present only when status = completed).\n",
            "example" : null
          },
          "error" : {
            "type" : "object",
            "deprecated" : false,
            "description" : "Error details describing the reason for failure (present only if status is failed).\n",
            "properties" : {
              "code" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "A Chargebee-defined code that corresponds to the specific error encountered during the fulfillment.\n\n* fulfillment_expired - Returned when the fulfillment has been in progress for more than 7 days, resulting in the system automatically marking it as failed.\n* internal_error - Returned when a system error occurred during fulfillment via checkout or billing updates.\n* external_fulfillment_failed - Returned when the fulfillment is marked as failed by the merchant, particularly in cases involving URL redirects, webhooks, and email processing types.\n* billing_update_failed - Returned when Chargebee is unable to fulfill the offer while updating the Chargebee billing subscription.\n* checkout_abandoned - Returned when the checkout process was abandoned by the user.\n",
                "enum" : [ "billing_update_failed", "checkout_abandoned", "external_fulfillment_failed", "internal_error", "fulfillment_expired" ],
                "example" : null
              },
              "message" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "A descriptive message about the error. This is intended for developer (or merchant) consumption and should not be displayed directly to end customers.\n",
                "maxLength" : 200,
                "example" : null
              }
            },
            "required" : [ "code", "message" ],
            "example" : null
          }
        },
        "required" : [ "created_at", "id", "option_id", "personalized_offer_id", "processing_type", "status" ],
        "example" : null
      },
      "OfflinePaymentMethod" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "no_preference", "cash", "check", "bank_transfer", "ach_credit", "sepa_credit", "boleto", "us_automated_bank_transfer", "eu_automated_bank_transfer", "uk_automated_bank_transfer", "jp_automated_bank_transfer", "mx_automated_bank_transfer", "custom" ],
        "example" : null
      },
      "OmnichannelSubscriptionItemOffer" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 40,
            "example" : null
          },
          "offer_id_at_source" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 100,
            "example" : null
          },
          "category" : {
            "type" : "string",
            "deprecated" : false,
            "enum" : [ "introductory", "promotional", "developer_determined" ],
            "example" : null
          },
          "category_at_source" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 100,
            "example" : null
          },
          "type" : {
            "type" : "string",
            "deprecated" : false,
            "enum" : [ "free_trial", "pay_up_front", "pay_as_you_go" ],
            "example" : null
          },
          "type_at_source" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 100,
            "example" : null
          },
          "discount_type" : {
            "type" : "string",
            "deprecated" : false,
            "enum" : [ "fixed_amount", "percentage", "price" ],
            "example" : null
          },
          "duration" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 5,
            "example" : null
          },
          "percentage" : {
            "type" : "number",
            "format" : "double",
            "deprecated" : false,
            "maximum" : 100,
            "minimum" : 0.01,
            "example" : null
          },
          "price_currency" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 3,
            "example" : null
          },
          "price_units" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "example" : null
          },
          "price_nanos" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "example" : null
          },
          "offer_term_start" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "example" : null
          },
          "offer_term_end" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "example" : null
          },
          "resource_version" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "example" : null
          }
        },
        "required" : [ "category", "duration", "id", "type" ],
        "example" : null
      },
      "OnEvent" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ],
        "example" : null
      },
      "Operation" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "create", "update", "delete" ],
        "example" : null
      },
      "Order" : {
        "type" : "object",
        "description" : "**Note:**\nThis doc is for the latest version of Chargebee Orders. If you enabled Chargebee Orders before *September-30-2018*\n, 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)\n\nOrders 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).\n",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Uniquely identifies the order. It is the api identifier for the order\n",
            "maxLength" : 40,
            "example" : null
          },
          "document_number" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The order's serial number\n",
            "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.\n",
            "maxLength" : 50,
            "example" : null
          },
          "subscription_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The subscription for which the order is created\n",
            "maxLength" : 50,
            "example" : null
          },
          "customer_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The customer for which the order is created\n",
            "maxLength" : 50,
            "example" : null
          },
          "status" : {
            "type" : "string",
            "default" : "new",
            "deprecated" : false,
            "description" : "The status of this order.\n\n* complete - Order has been processed successfully. Applicable only if you are using Chargebee's legacy order management system\n* partially_delivered - The order has been partially delivered to the customer.\n* voided - Order has been voided. Applicable only if you are using Chargebee's legacy order management system\n* on_hold - The order is paused from being processed.\n* awaiting_shipment - The order has been picked up by an integration system, and synced to a shipping management platform\n* shipped - The order has moved from order management system to a shipping system.\n* queued - Order is yet to be processed by any system, these are scheduled orders created by Chargebee\n* new - Order has been created. Applicable only if you are using Chargebee's legacy order management system.\n* returned - The order has been returned after delivery.\n* delivered - The order has been delivered to the customer.\n* cancelled - Order has been cancelled. Applicable only if you are using Chargebee's legacy order management system\n* processing - Order is being processed. Applicable only if you are using Chargebee's legacy order management system\n",
            "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\n\n* payment_declined - Payment declined.\n* shipping_cut_off_passed - The invoice has been paid late and Chargebee cancel's the first order for the invoice.\n* product_not_available - Product not available.\n* alternative_found - Alternative found.\n* others - Other reason\n* order_resent - Order resent\n* product_unsatisfactory - Product unsatisfactory.\n* delivery_date_missed - Delivery date missed.\n* fraudulent_transaction - Fraudulent transaction.\n* invoice_voided - The invoice for which the order was createed has been voided.\n* subscription_cancelled - The subsctiption for which the order was created has been cancelled.\n* invoice_written_off - The invoice has been completely written off. Orders are generated by Chargebee in cancelled state.\n* product_not_required - Product not required.\n* third_party_cancellation - Third party cancellation.\n",
            "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\n\n* paid - PAID\n* not_paid - NOT_PAID\n",
            "enum" : [ "not_paid", "paid" ],
            "example" : null
          },
          "order_type" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Order type\n\n* manual - The order has been created by the user using Chargebee's legacy order management system.\n* system_generated - The order has been created by Chargebee automatically based on the preferences set by the user.\n",
            "enum" : [ "manual", "system_generated" ],
            "example" : null
          },
          "price_type" : {
            "type" : "string",
            "default" : "tax_exclusive",
            "deprecated" : false,
            "description" : "The price type of the order\n\n* tax_inclusive - All amounts in the document are inclusive of tax.\n* tax_exclusive - All amounts in the document are exclusive of tax.\n",
            "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.\n",
            "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;\n",
            "maxLength" : 50,
            "example" : null
          },
          "order_date" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "The date on which the order will start getting processed.\n",
            "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.\n",
            "example" : null
          },
          "note" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The custom note for the order.\n",
            "maxLength" : 600,
            "example" : null
          },
          "tracking_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The tracking id of the order.\n",
            "maxLength" : 50,
            "example" : null
          },
          "tracking_url" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The tracking url of the order.\n",
            "maxLength" : 255,
            "example" : null
          },
          "batch_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Unique id to identify a group of orders.\n",
            "maxLength" : 50,
            "example" : null
          },
          "created_by" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The source (or the user) from where the order has been created.\n",
            "maxLength" : 50,
            "example" : null
          },
          "shipment_carrier" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Shipment carrier\n",
            "maxLength" : 50,
            "example" : null
          },
          "invoice_round_off_amount" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "The total round off taken from the invoice level\n",
            "minimum" : 0,
            "example" : null
          },
          "tax" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "The total tax for the order.\n",
            "minimum" : 0,
            "example" : null
          },
          "amount_paid" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Total amount paid for the order.\n",
            "minimum" : 0,
            "example" : null
          },
          "amount_adjusted" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Total amount adjusted for the order.\n",
            "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.\n",
            "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.\n",
            "minimum" : 0,
            "example" : null
          },
          "rounding_adjustement" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Rounding adjustment\n",
            "example" : null
          },
          "paid_on" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "The timestamp indicating the date \\& time the order's invoice got paid.\n",
            "example" : null
          },
          "shipping_cut_off_date" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "The time after which an order becomes unservicable\n",
            "example" : null
          },
          "created_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "The time at which the order was created\n",
            "example" : null
          },
          "status_update_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "The time at which the order status was last updated.\n",
            "example" : null
          },
          "delivered_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "The time at which the order was delivered\n",
            "example" : null
          },
          "shipped_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "The time at which the order was shipped.\n",
            "example" : null
          },
          "resource_version" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Version number of this resource. The `resource_version`\nis 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.\n",
            "example" : null
          },
          "updated_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "The order's last modified time.\n",
            "example" : null
          },
          "cancelled_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "The time at which the order was cancelled.\n",
            "example" : null
          },
          "resent_status" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Resent status of the order.\n\n* fully_resent - Order is Fully resent\n* partially_resent - Order is Partially resent\n",
            "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.\n",
            "example" : null
          },
          "original_order_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Refers to the original order id of the resent order.\n",
            "maxLength" : 40,
            "example" : null
          },
          "discount" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Total discount given for the order.\n",
            "minimum" : 0,
            "example" : null
          },
          "sub_total" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "The order's sub-total\n",
            "minimum" : 0,
            "example" : null
          },
          "total" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Total amount charged for the order.\n",
            "minimum" : 0,
            "example" : null
          },
          "deleted" : {
            "type" : "boolean",
            "deprecated" : false,
            "description" : "Indicates that this resource has been deleted.\n",
            "example" : null
          },
          "currency_code" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The currency code (ISO 4217 format) for the invoice\n",
            "maxLength" : 3,
            "example" : null
          },
          "is_gifted" : {
            "type" : "boolean",
            "default" : false,
            "deprecated" : false,
            "description" : "Boolean indicating whether this order is gifted or not.\n",
            "example" : null
          },
          "gift_note" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The gift message added by the gifter during purchase\n",
            "maxLength" : 500,
            "example" : null
          },
          "gift_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The gift_id if the order is a gift order\n",
            "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**.\nMust be passed if set as mandatory in the app. The codes are case-sensitive\n",
            "maxLength" : 100,
            "example" : null
          },
          "business_entity_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity.  \n**Note**\n\n[Multiple Business Entities](/docs/api/getting-started) is a feature available only on Product Catalog 2.0.\n",
            "maxLength" : 50,
            "example" : null
          },
          "order_line_items" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "The list of line items for this order.\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The identifier for the order line item.\n",
                  "maxLength" : 40,
                  "example" : null
                },
                "invoice_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The invoice of the line item.\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "invoice_line_item_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The invoice line item id associated with this order line item.\n",
                  "maxLength" : 40,
                  "example" : null
                },
                "unit_price" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "The unit price.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "description" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The line item description.\n",
                  "maxLength" : 250,
                  "example" : null
                },
                "amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "The sub total, of the order line item\n",
                  "minimum" : 0,
                  "example" : null
                },
                "fulfillment_quantity" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "description" : "The quantity that is going to get fulfilled for this order\n",
                  "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)\n",
                  "minimum" : 0,
                  "example" : null
                },
                "tax_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "The total tax applied on this line item\n",
                  "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\n",
                  "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\n",
                  "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\n",
                  "minimum" : 0,
                  "example" : null
                },
                "refundable_credits" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "The total amount issued as credits on behalf of this delivery\n",
                  "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\n",
                  "example" : null
                },
                "sku" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The SKU for the delivery.\n",
                  "maxLength" : 250,
                  "example" : null
                },
                "status" : {
                  "type" : "string",
                  "default" : "queued",
                  "deprecated" : false,
                  "description" : "The status of this order.\n\n* shipped - The order line item has been shipped.\n* on_hold - The delivery has been moved to \"On hold\" status.\n* cancelled - The order has been returned after delivery.\n* returned - The order has been returned after delivery.\n* partially_delivered - The order has been partially delivered to the customer.\n* delivered - The order line item has been delivered.\n* queued - Not processed for shipping yet.\n* awaiting_shipment - Moved to shipping platform.\n",
                  "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)\n/ [addon](/docs/api/v2/pcv-1/addons/addon-object)\netc) this line item is based on\n\n* plan -\n  Indicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)\n  id\n* plan_setup -\n  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)\n  id\n* adhoc - Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case\n* addon -\n  Indicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the [addon](/docs/api/v2/pcv-1/addons/addon-object)\n  id\n",
                  "enum" : [ "plan_setup", "plan", "addon", "adhoc" ],
                  "example" : null
                },
                "item_level_discount_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Item level discount amount\n",
                  "minimum" : 0,
                  "example" : null
                },
                "discount_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "The discount given on the order line item.\n",
                  "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\n",
                  "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.\n",
            "properties" : {
              "first_name" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The first name of the contact.\n",
                "maxLength" : 150,
                "example" : null
              },
              "last_name" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The last name of the contact.\n",
                "maxLength" : 150,
                "example" : null
              },
              "email" : {
                "type" : "string",
                "format" : "email",
                "deprecated" : false,
                "description" : "The email address.\n",
                "maxLength" : 70,
                "example" : null
              },
              "company" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The company name.\n",
                "maxLength" : 250,
                "example" : null
              },
              "phone" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The phone number.\n",
                "maxLength" : 50,
                "example" : null
              },
              "line1" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Address line 1\n",
                "maxLength" : 150,
                "example" : null
              },
              "line2" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Address line 2\n",
                "maxLength" : 150,
                "example" : null
              },
              "line3" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Address line 3\n",
                "maxLength" : 150,
                "example" : null
              },
              "city" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                "maxLength" : 50,
                "example" : null
              },
              "state" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The state/province name.\n",
                "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)\n.\n",
                "maxLength" : 20,
                "example" : null
              },
              "validation_status" : {
                "type" : "string",
                "default" : "not_validated",
                "deprecated" : false,
                "description" : "The address verification status.\n\n* not_validated - Address is not yet validated.\n* valid - Address was validated successfully.\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n",
                "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                "example" : null
              }
            },
            "example" : null
          },
          "billing_address" : {
            "type" : "object",
            "deprecated" : false,
            "description" : "Billing address for the order.\n",
            "properties" : {
              "first_name" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The first name of the billing contact.\n",
                "maxLength" : 150,
                "example" : null
              },
              "last_name" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The last name of the billing contact.\n",
                "maxLength" : 150,
                "example" : null
              },
              "email" : {
                "type" : "string",
                "format" : "email",
                "deprecated" : false,
                "description" : "The email address.\n",
                "maxLength" : 70,
                "example" : null
              },
              "company" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The company name.\n",
                "maxLength" : 250,
                "example" : null
              },
              "phone" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The phone number.\n",
                "maxLength" : 50,
                "example" : null
              },
              "line1" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Address line 1\n",
                "maxLength" : 150,
                "example" : null
              },
              "line2" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Address line 2\n",
                "maxLength" : 150,
                "example" : null
              },
              "line3" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Address line 3\n",
                "maxLength" : 150,
                "example" : null
              },
              "city" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                "maxLength" : 50,
                "example" : null
              },
              "state" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "State or Province\n",
                "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)\n.\n",
                "maxLength" : 20,
                "example" : null
              },
              "validation_status" : {
                "type" : "string",
                "default" : "not_validated",
                "deprecated" : false,
                "description" : "The address verification status.\n\n* valid - Address was validated successfully.\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n",
                "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.\n",
            "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\n",
                  "maxLength" : 40,
                  "example" : null
                },
                "tax_name" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The name of the tax applied\n",
                  "maxLength" : 100,
                  "example" : null
                },
                "tax_rate" : {
                  "type" : "number",
                  "format" : "double",
                  "default" : 0,
                  "deprecated" : false,
                  "description" : "The rate of tax used to calculate tax amount\n",
                  "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.\n",
                  "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.\n",
                  "example" : null
                },
                "prorated_taxable_amount" : {
                  "type" : "number",
                  "format" : "decimal",
                  "deprecated" : false,
                  "description" : "Indicates the prorated line item amount in cents.\n",
                  "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.\n",
                  "example" : null
                },
                "is_non_compliance_tax" : {
                  "type" : "boolean",
                  "deprecated" : false,
                  "description" : "Indicates the non-compliance tax that should not be reported to the jurisdiction.\n",
                  "example" : null
                },
                "taxable_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Indicates the actual portion of the line item amount that is taxable.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "tax_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "The tax amount\n",
                  "minimum" : 0,
                  "example" : null
                },
                "tax_juris_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The type of tax jurisdiction\n\n* federal - The tax jurisdiction is a federal\n* state - The tax jurisdiction is a state\n* county - The tax jurisdiction is a county\n* country - The tax jurisdiction is a country\n* city - The tax jurisdiction is a city\n* special - Special tax jurisdiction.\n* unincorporated - Combined tax of state and county.\n* other - Jurisdictions other than the ones listed above.\n",
                  "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\n",
                  "maxLength" : 250,
                  "example" : null
                },
                "tax_juris_code" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The tax jurisdiction code\n",
                  "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.\n",
                  "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.\n",
                  "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\n",
            "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.\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "discount_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Type of this discount line item\n\n* prorated_credits - Represents the credit adjustment items in invoice. The 'coupon_id' attribute will be null in this case\n* document_level_coupon -\n  Represents the 'Document' level coupons applied to this document. Further the 'coupon_id' attribute specifies the [coupon](/docs/api/coupons/coupon-object)\n  id this discount is based on\n* custom_discount - Represents the discount applied on an resent order against the orginal order.\n* promotional_credits - Represents the Promotional Credits item in invoice. The 'coupon_id' attribute will be null in this case\n* item_level_coupon -\n  Represents the 'Item' level coupons applied to this invoice. Further the 'coupon_id' attribute specifies the [coupon](/docs/api/coupons/coupon-object)\n  id this discount is based on\n",
                  "enum" : [ "item_level_coupon", "document_level_coupon", "promotional_credits", "prorated_credits", "custom_discount" ],
                  "example" : null
                },
                "entity_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 50,
                  "example" : null
                },
                "discount_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Discount amount.\n",
                  "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\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "The amount issued for this order\n",
                  "minimum" : 0,
                  "example" : null
                },
                "type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The credit note type. [Learn more](/docs/api/v2/pcv-1/credit_notes/credit-note-object)\nabout credit note types.\n\n* store - Store Credit Note\n* refundable - Refundable Credit Note\n* adjustment - Adjustment Credit Note\n",
                  "enum" : [ "adjustment", "refundable", "store" ],
                  "example" : null
                },
                "id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Credit-note id.\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "status" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The credit note status.\n\n* voided - When the Credit Note has been cancelled.\n* refunded - When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded).\n* adjusted - When the Credit Note has been adjusted against an invoice.\n* refund_due - When the credits are yet to be used, or have been partially used.\n",
                  "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'\n",
                  "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'\n",
                  "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.\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "order_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The order which is linked.\n",
                  "maxLength" : 40,
                  "example" : null
                },
                "reason" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The order resent reason.\n",
                  "maxLength" : 100,
                  "example" : null
                },
                "amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Value of the resent order.\n",
                  "minimum" : 0,
                  "example" : null
                }
              },
              "required" : [ "order_id" ],
              "example" : null
            },
            "example" : null
          }
        },
        "required" : [ "created_at", "deleted", "id", "is_resent", "price_type" ],
        "example" : null
      },
      "OrderCancelledEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "order" : {
                "$ref" : "#/components/schemas/Order"
              }
            },
            "required" : [ "order" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "OrderCreatedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "order" : {
                "$ref" : "#/components/schemas/Order"
              }
            },
            "required" : [ "order" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "OrderDeletedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "order" : {
                "$ref" : "#/components/schemas/Order"
              }
            },
            "required" : [ "order" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "OrderDeliveredEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "order" : {
                "$ref" : "#/components/schemas/Order"
              }
            },
            "required" : [ "order" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "OrderReadyToProcessEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "order" : {
                "$ref" : "#/components/schemas/Order"
              }
            },
            "required" : [ "order" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "OrderReadyToShipEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "order" : {
                "$ref" : "#/components/schemas/Order"
              }
            },
            "required" : [ "order" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "OrderResentEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "order" : {
                "$ref" : "#/components/schemas/Order"
              }
            },
            "required" : [ "order" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "OrderReturnedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "order" : {
                "$ref" : "#/components/schemas/Order"
              }
            },
            "required" : [ "order" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "OrderUpdatedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "order" : {
                "$ref" : "#/components/schemas/Order"
              }
            },
            "required" : [ "order" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "PauseOption" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "immediately", "end_of_term", "specific_date", "billing_cycles" ],
        "example" : null
      },
      "PaymentFailedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "transaction" : {
                "$ref" : "#/components/schemas/Transaction"
              },
              "invoice" : {
                "$ref" : "#/components/schemas/Invoice"
              },
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "subscription" : {
                "$ref" : "#/components/schemas/Subscription"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              }
            },
            "required" : [ "card", "customer", "invoice", "subscription", "transaction" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "PaymentInitiatedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "transaction" : {
                "$ref" : "#/components/schemas/Transaction"
              },
              "invoice" : {
                "$ref" : "#/components/schemas/Invoice"
              },
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "subscription" : {
                "$ref" : "#/components/schemas/Subscription"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              }
            },
            "required" : [ "card", "customer", "invoice", "subscription", "transaction" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "PaymentInitiator" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "customer", "merchant" ],
        "example" : null
      },
      "PaymentIntent" : {
        "type" : "object",
        "description" : "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.\n\n#### Auto-expiry\n\nAll `payment_intent`s with `status` as `inited`, `in_progress` or `authorized` become `expired` after an **hour** automatically.\n",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Identifier for PaymentIntent.\n",
            "maxLength" : 150,
            "example" : null
          },
          "status" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Current status of PaymentIntent.\n\n* in_progress - Status will be in_progress if the Active Payment Attempt state is in requires_identification, requires_challenge or requires_redirection.\n* inited - Intent is initialized.\n* authorized - 3DS verification successfully completed.\n* 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.\n* expired - Intent has expired, since it was not consumed before the predefined time-out.\n",
            "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.\n",
            "maxLength" : 3,
            "example" : null
          },
          "amount" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Amount(in cents) to be authorized for 3DS flow.\n",
            "minimum" : 0,
            "example" : null
          },
          "gateway_account_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The gateway account used for performing the 3DS flow.\n",
            "maxLength" : 50,
            "example" : null
          },
          "expires_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp indicating when the PaymentIntent will expire if left unconsumed.\n",
            "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.\n",
            "maxLength" : 200,
            "example" : null
          },
          "payment_method_type" : {
            "type" : "string",
            "default" : "card",
            "deprecated" : false,
            "description" : "The payment method of this intent\n\n* tamara - Payments made via Tamara.\n* alipay_hk - Payments made via Alipay HK.\n* apple_pay - apple_pay\n* netbanking_emandates - netbanking_emandates\n* venmo - Venmo\n* after_pay - Payments made via Afterpay\n* giropay - giropay\n* momo - Payments made via MoMo.\n* blik - Payments made via BLIK.\n* dana - Payments made via Dana.\n* paypal_express_checkout - paypal_express_checkout\n* touch_n_go - Payments made via Touch 'n Go.\n* pix - Pix\n* amazon_payments - amazon_payments\n* grab_pay - Payments made via GrabPay\n* card - card\n* affirm_pay - Payments made via Affirm Pay.\n* go_pay - Payments made via GoPay\n* google_pay - google_pay\n* cash_app_pay - Payments made via Cash App Pay.\n* ideal - ideal\n* nequi - Payments made via Nequi.\n* dotpay - dotpay\n* sofort - sofort\n* gcash - Payments made via GCash.\n* nupay - Payments made via NuPay.\n* faster_payments - Faster Payments\n* rakuten_pay - Payments made via Rakuten Pay.\n* qpay - Payments made via Qpay.\n* online_banking_poland - Online Banking Poland\n* klarna - Payments made via Klarna.\n* swish - Payments made via Swish\n* kbc_payment_button - KBC Payment Button\n* bancontact - bancontact\n* trustly - Trustly\n* fpx - Payments made via FPX.\n* paypay - PayPay\n* kakao_pay - Payments made via Kakao Pay.\n* boleto - boleto\n* revolut_pay - Payments made via Revolut Pay.\n* naver_pay - Payments made via Naver Pay.\n* electronic_payment_standard - Electronic Payment Standard\n* p24 - Payments made via Przelewy24 (P24).\n* thai_qr - Payments made via Thai QR.\n* pay_by_bank - Pay By Bank\n* payme - Payments made via PayMe\n* pay_co - Payments made via PayCo\n* ovo - Payments made via OVO.\n* pay_to - PayTo\n* alipay - Payments made via Alipay.\n* picpay - Payments made via PicPay.\n* sepa_instant_transfer - SEPA Instant Transfer\n* mercado_pago - Payments made via Mercado Pago.\n* direct_debit - direct_debit\n* klarna_pay_now - Klarna Pay Now\n* stablecoin - Payments made via Stablecoin.\n* upi - upi\n* south_korean_cards - Payments made via South Korean Cards\n* wero - Payments made via Wero.\n* payconiq_by_bancontact - Payments made via Payconiq by Bancontact.\n* twint - Payments made via Twint\n* wechat_pay - Payments made via WeChat 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
          },
          "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`\nis `ideal`\n, `sofort`\n, `dotpay`\nor `giropay`\n.\n",
            "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`\nis `ideal`\n, `sofort`\n, `dotpay`\nor `giropay`\n.\n",
            "maxLength" : 250,
            "example" : null
          },
          "created_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp indicating when the PaymentIntent was created.\n",
            "example" : null
          },
          "modified_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp indicating when the PaymentIntent was last modified.\n",
            "example" : null
          },
          "resource_version" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Version number of this resource. The `resource_version`\nis 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.\n",
            "example" : null
          },
          "updated_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp indicating when this payment intent was last updated.\n",
            "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.\n\n* `card`: Options for card payments.\n  * `three_d_secure`: Options for 3DS authentication.\n    * `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.\n      * `no_preference`: Chargebee, the gateway, and the issuer decide the 3DS flow.\n      * `no_challenge`: A frictionless flow without a challenge is requested.\n      * `challenge`: A challenge flow is requested.\n",
            "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.\n",
            "example" : null
          },
          "business_entity_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity.  \n**Note**\n\n[Multiple Business Entities](/docs/api/getting-started) is a feature available only on Product Catalog 2.0.\n",
            "maxLength" : 50,
            "example" : null
          },
          "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.\n",
            "maxLength" : 50,
            "example" : null
          },
          "active_payment_attempt" : {
            "type" : "object",
            "deprecated" : false,
            "description" : "Active payment attempt for the PaymentIntent.\n",
            "properties" : {
              "id" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Identifier for PaymentIntent's active payment attempt.\n",
                "maxLength" : 70,
                "example" : null
              },
              "status" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Current status of active payment attempt\n\n* requires_challenge - The transaction has to go through 3DS Challenge flow and the customer needs to authenticate via 3DS 2.0\n* inited - Payment attempt is initialized.\n* requires_identification - Customer's device fingerprint is used to verify their identity. It needs to be sent to the Issuing Bank for verification.\n* refused - 3DS verification attempt failed.\n* authorized - 3DS verification successfully completed.\n* pending_authorization - Waiting for the authorization.\n* requires_redirection - The transaction has to go through 3DS Redirection flow and the customer needs to authenticate via 3DS 1.0\n",
                "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\n\n* stablecoin - Stablecoin\n* venmo - Venmo\n* sofort - sofort\n* blik - Payments made via BLIK.\n* paypal_express_checkout - paypal_express_checkout\n* alipay - Alipay\n* giropay - giropay\n* dana - Payments made via Dana.\n* bancontact - bancontact\n* naver_pay - Naver Pay\n* go_pay - Go Pay\n* kakao_pay - Kakao Pay\n* card - card\n* faster_payments - Faster Payments\n* paypay - PayPay\n* south_korean_cards - Payments made via South Korean Cards\n* qpay - Payments made via Qpay.\n* kbc_payment_button - KBC Payment Button\n* nupay - Payments made via NuPay.\n* momo - Payments made via MoMo.\n* ideal - ideal\n* sepa_instant_transfer - SEPA Instant Transfer\n* gcash - Payments made via GCash.\n* nequi - Payments made via Nequi.\n* wero - Payments made via Wero.\n* pay_by_bank - Pay By Bank\n* klarna - Payments made via Klarna.\n* online_banking_poland - Online Banking Poland\n* p24 - Payments made via Przelewy24 (P24).\n* swish - Swish\n* electronic_payment_standard - Electronic Payment Standard\n* boleto - boleto\n* wechat_pay - WeChat Pay\n* cash_app_pay - Cash App Pay\n* revolut_pay - Revolut Pay\n* rakuten_pay - Payments made via Rakuten Pay.\n* fpx - Payments made via FPX.\n* thai_qr - Payments made via Thai QR.\n* grab_pay - Grab Pay\n* trustly - Trustly\n* payme - PayMe\n* alipay_hk - Payments made via Alipay HK.\n* touch_n_go - Payments made via Touch 'n Go.\n* upi - upi\n* amazon_payments - amazon_payments\n* direct_debit - direct_debit\n* after_pay - After Pay\n* mercado_pago - Payments made via Mercado Pago.\n* dotpay - dotpay\n* apple_pay - apple_pay\n* netbanking_emandates - netbanking_emandates\n* affirm_pay - Payments made via Affirm Pay.\n* klarna_pay_now - Klarna Pay Now\n* google_pay - google_pay\n* ovo - Payments made via OVO.\n* picpay - Payments made via PicPay.\n* payconiq_by_bancontact - Payconiq by Bancontact\n* pay_co - Pay Co\n* twint - Twint\n* tamara - Payments made via Tamara.\n* pay_to - PayTo\n* pix - Payments made via Pix\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
              },
              "id_at_gateway" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Reference of PaymentIntent at gateway\n",
                "maxLength" : 50,
                "example" : null
              },
              "error_code" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Error code received from the payment gateway when the `payment_attempt`\nfails.\n",
                "maxLength" : 100,
                "example" : null
              },
              "error_text" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Error message received from the payment gateway on failure.\n",
                "maxLength" : 65000,
                "example" : null
              },
              "checkout_details" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "JSON-encoded object that includes customer and browser details collected during checkout.\n",
                "maxLength" : 65000,
                "example" : null
              },
              "created_at" : {
                "type" : "integer",
                "format" : "unix-time",
                "deprecated" : false,
                "description" : "Timestamp indicating when the active payment attempt was created.\n",
                "example" : null
              },
              "modified_at" : {
                "type" : "integer",
                "format" : "unix-time",
                "deprecated" : false,
                "description" : "Timestamp indicating when the active payment attempt was last modified.\n",
                "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)\n",
                "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\n",
                    "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\n",
                    "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\n",
                    "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\n",
                    "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\n",
                    "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\n",
                    "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\n",
                    "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\n",
                    "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\n",
                    "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\n",
                    "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\n",
                    "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\n",
                    "maxLength" : 100,
                    "example" : null
                  },
                  "processor_error_message" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "This message describes the specific error that the payment processor encountered\n",
                    "maxLength" : 65000,
                    "example" : null
                  },
                  "error_cause_id" : {
                    "type" : "string",
                    "deprecated" : false,
                    "description" : "A [Chargebee-defined code](/docs/api/errors)\nthat 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.\n",
                    "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.\n",
                    "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`.\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Identifier for the payment attempt.\n",
                  "maxLength" : 70,
                  "example" : null
                },
                "status" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Current status of the payment attempt.\n\n* 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.\n* requires_identification - Customer's device fingerprint is used to verify their identity. It needs to be sent to the Issuing Bank for verification.\n* requires_redirection -\n  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)\n  or [failure_url](/docs/api/payment_intents/payment_intent-object#failure_url)\n  .\n* inited - Payment attempt is initialized.\n* authorized - 3DS verification successfully completed.\n* pending_authorization - Waiting for the authorization.\n* refused - 3DS verification attempt failed.\n",
                  "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.\n\n* swish - Payments made via Swish\n* stablecoin - Payments made via Stablecoin.\n* revolut_pay - Payments made via Revolut Pay.\n* rakuten_pay - Payments made via Rakuten Pay.\n* alipay - Payments made via Alipay.\n* nupay - Payments made via NuPay.\n* sofort - sofort\n* giropay - giropay\n* electronic_payment_standard - Electronic Payment Standard\n* paypay - PayPay\n* boleto - boleto\n* kakao_pay - Payments made via Kakao Pay.\n* pix - Pix\n* kbc_payment_button - KBC Payment Button\n* faster_payments - Faster Payments\n* paypal_express_checkout - paypal_express_checkout\n* go_pay - Payments made via GoPay\n* ovo - Payments made via OVO.\n* pay_by_bank - Pay By Bank\n* klarna - Payments made via Klarna.\n* after_pay - Payments made via Afterpay\n* bancontact - bancontact\n* trustly - Trustly\n* wechat_pay - Payments made via WeChat Pay.\n* twint - Payments made via Twint\n* wero - Payments made via Wero.\n* upi - upi\n* cash_app_pay - Payments made via Cash App Pay.\n* direct_debit - direct_debit\n* thai_qr - Payments made via Thai QR.\n* mercado_pago - Payments made via Mercado Pago.\n* netbanking_emandates - netbanking_emandates\n* amazon_payments - amazon_payments\n* sepa_instant_transfer - SEPA Instant Transfer\n* klarna_pay_now - Klarna Pay Now\n* online_banking_poland - Online Banking Poland\n* touch_n_go - Payments made via Touch 'n Go.\n* fpx - Payments made via FPX.\n* dotpay - dotpay\n* google_pay - google_pay\n* payconiq_by_bancontact - Payments made via Payconiq by Bancontact.\n* payme - Payments made via PayMe\n* card - card\n* affirm_pay - Payments made via Affirm Pay.\n* naver_pay - Payments made via Naver Pay.\n* blik - Payments made via BLIK.\n* nequi - Payments made via Nequi.\n* dana - Payments made via Dana.\n* alipay_hk - Payments made via Alipay HK.\n* south_korean_cards - Payments made via South Korean Cards\n* ideal - ideal\n* p24 - Payments made via Przelewy24 (P24).\n* grab_pay - Payments made via GrabPay\n* pay_co - Payments made via PayCo\n* picpay - Payments made via PicPay.\n* momo - Payments made via MoMo.\n* venmo - Venmo\n* gcash - Payments made via GCash.\n* apple_pay - apple_pay\n* tamara - Payments made via Tamara.\n* qpay - Payments made via Qpay.\n* pay_to - PayTo\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
                },
                "id_at_gateway" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Reference of the payment attempt at the gateway.\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "error_code" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Error code received from the payment gateway on failure.\n",
                  "maxLength" : 100,
                  "example" : null
                },
                "error_text" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Error message received from the payment gateway on failure.\n",
                  "maxLength" : 65000,
                  "example" : null
                },
                "checkout_details" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "JSON-encoded object that includes customer and browser details collected during checkout.\n",
                  "maxLength" : 65000,
                  "example" : null
                },
                "created_at" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "Timestamp indicating when the payment attempt was created.\n",
                  "example" : null
                },
                "modified_at" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "Timestamp indicating when the payment attempt was last modified.\n",
                  "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)\n",
                  "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\n",
                      "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\n",
                      "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\n",
                      "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\n",
                      "maxLength" : 65000,
                      "example" : null
                    },
                    "decline_code" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "Code provided by the gateway that specifies the reason for the transaction decline.\n",
                      "maxLength" : 100,
                      "example" : null
                    },
                    "decline_message" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "Descriptive message explaining the reason for the transaction's decline.\n",
                      "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\n",
                      "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\n",
                      "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\n",
                      "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\n",
                      "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\n",
                      "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\n",
                      "maxLength" : 100,
                      "example" : null
                    },
                    "processor_error_message" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "This message describes the specific error that the payment processor encountered\n",
                      "maxLength" : 65000,
                      "example" : null
                    },
                    "error_cause_id" : {
                      "type" : "string",
                      "deprecated" : false,
                      "description" : "A [Chargebee-defined code](/docs/api/errors)\nthat 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.\n",
                      "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.\n",
                      "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`.\n",
                  "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`.\n",
                  "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.\n",
            "properties" : {
              "source" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The source of the request that confirmed the payment intent.\n\n* portal - The request came from the [Self-Serve Portal](https://www.chargebee.com/docs/billing/1.0/hosted-capabilities/self-serve-portal).\n* collect_now - The request came from the [Collect Now](https://apidocs.chargebee.com/docs/api/v2/pcv-1/hosted_pages/collect-now) hosted page.\n* card_components - The request came from Chargebee.js [Card Components](https://www.chargebee.com/docs/payments/2.0/card-components-and-helpers/card-components).\n* checkout - The request came from [hosted checkout](https://www.chargebee.com/docs/billing/1.0/hosted-capabilities/hosted-checkout), including hosted checkout for [gift subscriptions](https://www.chargebee.com/docs/billing/1.0/subscriptions/gift-subscriptions#gift-subscription-workflow).\n* payment_components - The request came from Chargebee.js [Payment Components](https://www.chargebee.com/docs/payments/2.0/payment-components/overview).\n* 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).\n",
                "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.\n",
                "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.\n",
                "maxLength" : 1000,
                "example" : null
              },
              "created_at" : {
                "type" : "integer",
                "format" : "unix-time",
                "deprecated" : false,
                "description" : "Timestamp indicating when Chargebee captured this metadata.\n",
                "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.\n",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The `id`\nof the `payment_reference_number`\nresource is a unique identifier assigned to the PRN to track and reference in systems.\n",
            "maxLength" : 40,
            "example" : null
          },
          "type" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "This attribute helps `type`\nfield in the API, specifies how to reconcile offline payments, and generate `payment_reference_number`\non invoices based on country-specific rules. Setting the `type`\nfield generates `payment_reference_number`\nfor the respective country and includes them on the invoice for correct reconciliation.\n\n* 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.\n* fik - Denmark based number calculated using recursive MOD 10 algorithm.\n* kid - The KID number (kundeidentifikasjon) in Norway is an abbreviation for \"Customer identification\". It is used to associate payments with the customer and invoice.\n* 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.\n",
            "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.\n",
            "maxLength" : 100,
            "example" : null
          },
          "invoice_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The `invoice_id`\nof the payment reference number (PRN) resource is the unique identifier assigned to the invoice that the PRN is associated with.\n",
            "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`\non an invoice is divided into smaller, more manageable parts, each of which is paid over a specified period.\n\n`reference_transactions[]` lists the payment attempts referenced against those installments.\n",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "An auto-generated unique identifier for the payment schedule.\n",
            "maxLength" : 40,
            "example" : null
          },
          "scheme_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The identifier of the `payment_schedule_scheme`\n, used to create the payment schedules.\n",
            "maxLength" : 40,
            "example" : null
          },
          "entity_type" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Specifies the types of entity this payment schedule is based on.\n\n* invoice - invoice\n",
            "enum" : [ "invoice" ],
            "example" : null
          },
          "entity_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The identifier of the entity this payment schedule is based on.\n",
            "maxLength" : 50,
            "example" : null
          },
          "amount" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Defines the amount set for an invoice as part of payment schedules. If this is not sent, the total invoice due amount will be taken as payment schedule amount\n",
            "minimum" : 0,
            "example" : null
          },
          "created_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Specifies when these payment schedules are created.\n",
            "example" : null
          },
          "resource_version" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Version number of this resource. The `resource_version`\nis 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.\n",
            "example" : null
          },
          "updated_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Specifies when these payment schedules are updated recently.\n",
            "example" : null
          },
          "currency_code" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The currency code (ISO 4217 format) of the transaction amount.\n",
            "maxLength" : 3,
            "example" : null
          },
          "schedule_entries" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "List of schedule entries\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "An auto-generated unique identifier for the payment schedules.\n",
                  "maxLength" : 40,
                  "example" : null
                },
                "date" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "date at which this payment schedule is scheduled\n",
                  "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`.\n",
                  "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.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "status" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Defines the status for each payment schedule.\n\n* posted - posted\n* payment_due - payment_due\n* paid - paid\n",
                  "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.\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "schedule_entry_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The identifier of the [`schedule_entries[]`](/docs/api/v2/pcv-1/payment_schedules#payment_schedule_schedule_entries) item this transaction is linked to.\n",
                  "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.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "txn_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Uniquely identifies the transaction.\n",
                  "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/v2/pcv-1/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/v2/pcv-1/transactions#transaction_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.\n",
                  "example" : null
                },
                "txn_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Total amount of the transaction.\n",
                  "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
      },
      "PaymentSource" : {
        "type" : "object",
        "description" : "**Updates**\n\nThis API obsoletes the [Cards API](/docs/api/cards)\nin Chargebee.\n\nRepresents 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.\n",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Identifier of the payment source\n",
            "maxLength" : 40,
            "example" : null
          },
          "resource_version" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Version number of this resource. The `resource_version`\nis 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.\n",
            "example" : null
          },
          "updated_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp indicating when this payment source resource was last updated.\n",
            "example" : null
          },
          "created_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp indicating when this payment source resource is created.\n",
            "example" : null
          },
          "customer_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Identifier of the customer with whom this payment source is associated.\n",
            "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.\n**Note:**\nThis is not the one time temporary token provided by gateways like Stripe.\n",
            "maxLength" : 200,
            "example" : null
          },
          "status" : {
            "type" : "string",
            "default" : "valid",
            "deprecated" : false,
            "description" : "Current status of the payment source.\n\n* valid - A payment source that is valid and active.\n* expiring - A payment source that is expiring (like card's status based on its expiry date).\n* invalid - The billing agreement cannot be used. It might become valid again either automatically or due to customer action.\n* pending_verification - The payment source needs to be verified\n* expired - A payment source that has expired\n",
            "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 end-to-end 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.\n",
            "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.\n",
            "maxLength" : 50,
            "example" : null
          },
          "issuing_country" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "[two-letter(alpha2)](https://www.iso.org/iso-3166-country-codes.html)\nISO country code.\n",
            "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.\n",
            "example" : null
          },
          "deleted" : {
            "type" : "boolean",
            "deprecated" : false,
            "description" : "Indicates that this resource has been deleted.\n",
            "example" : null
          },
          "business_entity_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity.  \n**Note**\n\n[Multiple Business Entities](/docs/api/getting-started) is a feature available only on Product Catalog 2.0.\n",
            "maxLength" : 50,
            "example" : null
          },
          "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.\n",
            "maxLength" : 50,
            "example" : null
          },
          "card" : {
            "type" : "object",
            "deprecated" : false,
            "description" : "Card details associated with this payment source.\n",
            "properties" : {
              "first_name" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Cardholder's first name\n",
                "maxLength" : 50,
                "example" : null
              },
              "last_name" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Cardholder's last name\n",
                "maxLength" : 50,
                "example" : null
              },
              "email" : {
                "type" : "string",
                "format" : "email",
                "deprecated" : false,
                "description" : "Email address of the cardholder\n",
                "maxLength" : 70,
                "example" : null
              },
              "iin" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The Issuer Identification Number, i.e. the first six digits of the card number\n",
                "maxLength" : 6,
                "minLength" : 6,
                "example" : null
              },
              "last4" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Last four digits of the card number\n",
                "maxLength" : 4,
                "minLength" : 4,
                "example" : null
              },
              "brand" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Card brand\n\n* cartes_bancaires - A Cartes Bancaires card.\n* not_applicable - Used for offline entries in transactions. Not applicable for cards\n* maestro - A Maestro card.\n* dankort - A Dankort card.\n* tarjeta_naranja - A Tarjeta Naranja card.\n* jcb - A JCB card.\n* other - Card belonging to types other than those listed above.\n* cmr_falabella - A CMR Falabella card.\n* discover - A Discover card.\n* elo - A Elo card.\n* diners_club - A Diner's Club card.\n* mada - A Mada card.\n* cabal - A Cabal card.\n* american_express - An American Express card.\n* visa - A Visa card.\n* cencosud - A Cencosud card.\n* carnet - A Carnet card.\n* argencard - An Argencard.\n* mastercard - A MasterCard.\n* hipercard - An Hipercard.\n* bancontact - A Bancontact card.\n* rupay - A Rupay card.\n* nativa - A Nativa card.\n",
                "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\n\n* not_known - An unknown card.\n* debit - A debit card.\n* credit - A credit card.\n* not_applicable - Used for ACH. Not applicable for cards\n* prepaid - A prepaid card.\n",
                "enum" : [ "credit", "debit", "prepaid", "not_known", "not_applicable" ],
                "example" : null
              },
              "expiry_month" : {
                "type" : "integer",
                "format" : "int32",
                "deprecated" : false,
                "description" : "Card expiry month.\n",
                "maximum" : 12,
                "minimum" : 1,
                "example" : null
              },
              "expiry_year" : {
                "type" : "integer",
                "format" : "int32",
                "deprecated" : false,
                "description" : "Card expiry year.\n",
                "example" : null
              },
              "billing_addr1" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Address line 1, as available in card billing address.\n",
                "maxLength" : 150,
                "example" : null
              },
              "billing_addr2" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Address line 2, as available in card billing address.\n",
                "maxLength" : 150,
                "example" : null
              },
              "billing_city" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "City, as available in card billing address.\n",
                "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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `billing_state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                "maxLength" : 50,
                "example" : null
              },
              "billing_state" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The state/province name.\n",
                "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.\n",
                "maxLength" : 20,
                "example" : null
              },
              "masked_number" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Masked credit card number that is safe to show.\n",
                "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.\n",
            "properties" : {
              "last4" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Last four digits of the bank account number\n",
                "maxLength" : 4,
                "minLength" : 4,
                "example" : null
              },
              "name_on_account" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Account holder's name as per bank account.\n",
                "maxLength" : 300,
                "example" : null
              },
              "first_name" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Account holder's first name as per bank account.\n",
                "maxLength" : 150,
                "example" : null
              },
              "last_name" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Account holder's last name as per bank account.\n",
                "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.\n\n* becs_nz - The Bulk Electronic Clearing System (BECS) is a Direct Debit scheme and followed in New-Zealand for Direct Debit system.\n* becs - The Bulk Electronic Clearing System (BECS) is a Direct Debit scheme and followed in Australia for Direct Debit system.\n* pad - Pre-Authorized Debit (PAD) is the scheme used for collecting Direct Debit payments from customers in Canada.\n* ach - US Bank Account\n* sepa_core - SEPA Direct Debit is a Europe-wide Direct Debit system that allows merchants to collect Euro-denominated payments.\n* autogiro - Bg Autogiro is a Direct Debit scheme for collecting Krona-denominated payments from a bank account in Sweden.\n* 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.\n* not_applicable - not_applicable\n",
                "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.\n",
                "maxLength" : 100,
                "example" : null
              },
              "mandate_id" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Mandate Id. Applicable for SEPA, BACS, Autogiro, and BECS.\n",
                "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/)\nACH and Razorpay NetBanking users only. If not passed, account type is taken as null.\n\n* checking - Checking Account\n* business_checking - Business Checking Account\n* savings - Savings Account\n* current - Current Account\n",
                "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.\n\n* ppd - Payment Authorization is prearranged between the customer and the merchant.\n* ccd - Payment Authorization agreement from the corporate customer is required. Applicable for business_checking account_type.\n* web - Payment Authorization obtained from the customer via the internet.\n",
                "enum" : [ "web", "ppd", "ccd" ],
                "example" : null
              },
              "account_holder_type" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "For Stripe ACH users only. Indicates the account holder type.\n\n* individual - Individual Account.\n* company - Company Account.\n",
                "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.\n",
                "maxLength" : 70,
                "example" : null
              }
            },
            "required" : [ "last4" ],
            "example" : null
          },
          "boleto" : {
            "type" : "object",
            "deprecated" : false,
            "description" : "Boleto payment source details of the customer\n",
            "properties" : {
              "last4" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Last four digits of unique id for voucher payment source ex: tax_id\n",
                "maxLength" : 4,
                "minLength" : 4,
                "example" : null
              },
              "first_name" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Customer first name as per voucher payment source.\n",
                "maxLength" : 150,
                "example" : null
              },
              "last_name" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Customer last name as per voucher payment source.\n",
                "maxLength" : 150,
                "example" : null
              },
              "email" : {
                "type" : "string",
                "format" : "email",
                "deprecated" : false,
                "description" : "Email address associated Customer's voucher payment source.\n",
                "maxLength" : 70,
                "example" : null
              }
            },
            "required" : [ "last4" ],
            "example" : null
          },
          "billing_address" : {
            "type" : "object",
            "deprecated" : false,
            "description" : "Billing address for the payment source.\n",
            "properties" : {
              "first_name" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The first name of the billing contact.\n",
                "maxLength" : 150,
                "example" : null
              },
              "last_name" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The last name of the billing contact.\n",
                "maxLength" : 150,
                "example" : null
              },
              "email" : {
                "type" : "string",
                "format" : "email",
                "deprecated" : false,
                "description" : "The email address.\n",
                "maxLength" : 70,
                "example" : null
              },
              "company" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The company name.\n",
                "maxLength" : 250,
                "example" : null
              },
              "phone" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The phone number.\n",
                "maxLength" : 50,
                "example" : null
              },
              "line1" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Address line 1\n",
                "maxLength" : 150,
                "example" : null
              },
              "line2" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Address line 2\n",
                "maxLength" : 150,
                "example" : null
              },
              "line3" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Address line 3\n",
                "maxLength" : 150,
                "example" : null
              },
              "city" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                "maxLength" : 50,
                "example" : null
              },
              "state" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "State or Province\n",
                "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)\n.\n",
                "maxLength" : 20,
                "example" : null
              },
              "validation_status" : {
                "type" : "string",
                "default" : "not_validated",
                "deprecated" : false,
                "description" : "The address verification status.\n\n* valid - Address was validated successfully.\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n",
                "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.\n",
            "properties" : {
              "email" : {
                "type" : "string",
                "format" : "email",
                "deprecated" : false,
                "description" : "Email address associated with Amazon payment account\n",
                "maxLength" : 70,
                "example" : null
              },
              "agreement_id" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Billing agreement id\n",
                "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.\n",
            "properties" : {
              "vpa" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "A unique identifier mapped with an individuals bank account to help UPI track the account.\n",
                "maxLength" : 100,
                "example" : null
              }
            },
            "example" : null
          },
          "paypal" : {
            "type" : "object",
            "deprecated" : false,
            "description" : "PayPal Express Checkout details associated with this payment source.\n",
            "properties" : {
              "email" : {
                "type" : "string",
                "format" : "email",
                "deprecated" : false,
                "description" : "Email address associated with PayPal Express Checkout\n",
                "maxLength" : 70,
                "example" : null
              },
              "agreement_id" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Billing agreement id\n",
                "maxLength" : 50,
                "example" : null
              }
            },
            "example" : null
          },
          "venmo" : {
            "type" : "object",
            "deprecated" : false,
            "description" : "Venmo details associated with this payment source.\n",
            "properties" : {
              "user_name" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "User name associated with customer's account in Venmo\n",
                "maxLength" : 50,
                "example" : null
              }
            },
            "example" : null
          },
          "klarna_pay_now" : {
            "type" : "object",
            "deprecated" : false,
            "description" : "Klarna Pay Now payment source details of the customer\n",
            "properties" : {
              "email" : {
                "type" : "string",
                "format" : "email",
                "deprecated" : false,
                "description" : "Email address associated Customer's klarna payment source.\n",
                "maxLength" : 70,
                "example" : null
              }
            },
            "example" : null
          },
          "mandates" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "Mandate details associated with the payment source.\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "A unique mandate identifier used for recurring payments.\n",
                  "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.\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "created_at" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "Timestamp indicating when the mandate is created\n",
                  "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
      },
      "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:**\nThis 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.\n",
            "maxLength" : 40,
            "example" : null
          },
          "id_at_gateway" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The id with which this voucher is referred in gateway.\n",
            "maxLength" : 100,
            "example" : null
          },
          "payment_voucher_type" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Type of the payment source.\n\n* boleto - Boleto\n",
            "enum" : [ "boleto" ],
            "example" : null
          },
          "expires_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp indicating when the Voucher will expire if left unconsumed.\n",
            "example" : null
          },
          "status" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Current status of Payment Voucher.\n\n* consumed - Consumed for a transaction and cannot be used again\n* expired - Expired before consumed and cannot be used again\n* active - Active and ready to be consumed\n* failure - Failed to create the voucher due to gateway rejection\n",
            "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.\n",
            "maxLength" : 50,
            "example" : null
          },
          "currency_code" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The currency code (ISO 4217 format) for the voucher.\n",
            "maxLength" : 3,
            "example" : null
          },
          "amount" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Amount for this payment voucher.\n",
            "minimum" : 1,
            "example" : null
          },
          "gateway_account_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The gateway account used for this voucher\n",
            "maxLength" : 50,
            "example" : null
          },
          "payment_source_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Identifier of the payment source for which this payment voucher is created\n",
            "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 end-to-end 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\n",
            "maxLength" : 65000,
            "example" : null
          },
          "error_code" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Error code received from the payment gateway on failure.\n",
            "maxLength" : 100,
            "example" : null
          },
          "error_text" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Error message received from the payment gateway on failure.\n",
            "maxLength" : 65000,
            "example" : null
          },
          "url" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Chargebee Hosted Page url for payment voucher\n",
            "maxLength" : 65000,
            "example" : null
          },
          "date" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Indicates when this payment voucher occurred date.\n",
            "example" : null
          },
          "resource_version" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Version number of this resource. The `resource_version`\nis 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.\n",
            "example" : null
          },
          "updated_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp indicating when this voucher was last updated.\n",
            "example" : null
          },
          "customer_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Identifier of the customer.\n",
            "maxLength" : 50,
            "example" : null
          },
          "linked_invoices" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "Invoices related to the generated voucher\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "invoice_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Identifier for the invoice.\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "txn_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Uniquely identifies the payment voucher.\n",
                  "maxLength" : 40,
                  "example" : null
                },
                "applied_at" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "Timestamp at which the transaction is applied.\n",
                  "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
      },
      "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).\nGrowth 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:\n\n* `Acquire`: Incentivize trial users or prospects to subscribe.\n* `Expand`: Encourage existing subscribers to purchase higher-value products or add-ons.\n* `Retain`: Engage at-risk subscribers with targeted winbacks or discounts.\n\n**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.\n\n**Features of this object**\n\nThe Personalized Offers object enables you to:\n\n* Fetch context-aware offers generated by the Growth system.\n* Display offer content (title and description) to subscribers.\n* Provide subscribers with options they can act on.\n* Attribute offers to the correct brand (for multi-brand merchants).\n* Respect time-bound validity with the expires_at attribute.\n",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "A unique and immutable identifier for the personalized offer.\n",
            "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.\n",
            "maxLength" : 50,
            "example" : null
          },
          "content" : {
            "type" : "object",
            "deprecated" : false,
            "description" : "The offer content to display to the user, includes title \\& description.\n",
            "properties" : {
              "title" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The offer headline to display to the end user.\n",
                "maxLength" : 100,
                "example" : null
              },
              "description" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The offer content or description.\n",
                "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.\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "A unique identifier for a specific option within the offer.\n",
                  "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.\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "processing_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The processing mode of the option. Possible values: billing_update, checkout, url_redirect, webhook, email. This indicates how the offer option is fulfilled: e.g., a direct billing change, a checkout flow, or a redirect to a URL.\n\n* email - Chargebee sends an email as configured in the Growth application and the fulfillment is processed by merchant's system\n* checkout - The offer fulfillment is processed using Chargebee hosted checkout\n* webhook - Chargebee triggers webhook and fulfillment is processed by merchant's system\n* url_redirect - The offer fulfillment is processed by merchant's system\n* billing_update - The offer fulfillment is processed by Chargebee\n",
                  "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.\n\n* in_app - Use an embedded checkout experience within the current interface.\n* full_page - Redirect the user to a dedicated full-page checkout.\n",
                  "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'\n",
                  "maxLength" : 250,
                  "example" : null
                }
              },
              "required" : [ "id", "label", "processing_layout", "processing_type", "redirect_url" ],
              "example" : null
            },
            "example" : null
          }
        },
        "required" : [ "content", "id", "offer_id", "options" ],
        "example" : null
      },
      "Plan" : {
        "type" : "object",
        "additionalProperties" : true,
        "description" : "Specifies the price with billing frequency for a subscription. Create separate plans for varied price or billing frequency. For example, if you need to charge $10 per month for a group of customers and $100 per year for another group of customers, then create separate plans for each.\n",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "A unique ID for your system to identify the plan.\n",
            "maxLength" : 100,
            "example" : null
          },
          "name" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The display name used in web interface for identifying the plan.\n",
            "maxLength" : 100,
            "example" : null
          },
          "invoice_name" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Display name used in invoice. If it is not configured then name is used in invoice.\n",
            "maxLength" : 100,
            "example" : null
          },
          "description" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Description about the plan to show in the hosted pages \\& customer portal.\n**Note:**\n\nIf your input contains characters that are subjected to sanitization (like incomplete HTML tags), the sanitization process might increase the length of your input. If the sanitized input exceeds the limit, your request will be rejected.\n",
            "maxLength" : 2000,
            "example" : null
          },
          "price" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "The price of the plan. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
            "minimum" : 0,
            "example" : null
          },
          "currency_code" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The currency code (ISO 4217 format) of the plan\n",
            "maxLength" : 3,
            "example" : null
          },
          "period" : {
            "type" : "integer",
            "format" : "int32",
            "default" : 1,
            "deprecated" : false,
            "description" : "Defines billing frequency. Example: to bill customer every 3 months, provide \"3\" here.\n",
            "minimum" : 1,
            "example" : null
          },
          "period_unit" : {
            "type" : "string",
            "default" : "month",
            "deprecated" : false,
            "description" : "Defines billing frequency in association with billing period.\n\n* month - Charge based on month(s)\n* day - Charge based on day(s)\n* week - Charge based on week(s)\n* year - Charge based on year(s)\n",
            "enum" : [ "day", "week", "month", "year" ],
            "example" : null
          },
          "trial_period" : {
            "type" : "integer",
            "format" : "int32",
            "deprecated" : false,
            "description" : "The free time window for your customer to try your product\n",
            "minimum" : 1,
            "example" : null
          },
          "trial_period_unit" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Time unit for the trial period.\n\n* month - In months\n* day - In days\n",
            "enum" : [ "day", "month" ],
            "example" : null
          },
          "trial_end_action" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Applicable only when [End-of-trial Action](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)\nhas been enabled for the site. Whenever the plan has a trial period, this attribute (parameter) is returned (required) and specifies the operation to be carried out for the subscription once the trial ends. This can be overridden at the [subscription-level](/docs/api/v2/pcv-1/subscriptions/subscription-object#trial_end_action)\n.\n\n* cancel_subscription - The subscription cancels.\n* activate_subscription - The subscription activates and charges are raised for non-metered items.\n* site_default -\n  The action [configured for the site](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)\n  at the time when the trial ends, takes effect.\n",
            "enum" : [ "site_default", "activate_subscription", "cancel_subscription" ],
            "example" : null
          },
          "pricing_model" : {
            "type" : "string",
            "default" : "flat_fee",
            "deprecated" : false,
            "description" : "Defines how the recurring charges for the subscription is calculated.\n\n* tiered - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.\n* per_unit - A fixed price per unit quantity.\n* flat_fee - A fixed price that is not quantity-based.\n* volume - The per unit price is based on the tier that the total quantity falls in.\n* stairstep - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.\n",
            "enum" : [ "flat_fee", "per_unit", "tiered", "volume", "stairstep" ],
            "example" : null
          },
          "free_quantity" : {
            "type" : "integer",
            "format" : "int32",
            "default" : 0,
            "deprecated" : false,
            "description" : "Free quantity the subscriptions of this plan will have. Only the quantity more than this will be charged for the subscription.\n",
            "minimum" : 0,
            "example" : null
          },
          "setup_cost" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "One-time setup fee charged as part of the first invoice.\n",
            "minimum" : 1,
            "example" : null
          },
          "status" : {
            "type" : "string",
            "default" : "active",
            "deprecated" : false,
            "description" : "The plan state\n\n* archived - No new subscriptions allowed for the plan. Existing subscriptions on this plan will remain as-is and can be migrated to another active plan if required.\n* active - New subscriptions can be created with the plan.\n* deleted - Indicates the plan has been deleted.\n",
            "enum" : [ "active", "archived", "deleted" ],
            "example" : null
          },
          "archived_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Time at which the plan was moved to archived status.\n",
            "example" : null
          },
          "billing_cycles" : {
            "type" : "integer",
            "format" : "int32",
            "deprecated" : false,
            "description" : "The number of billing cycles the subscription is active. The subscription is moved to non renewing state and then to cancelled state automatically\n",
            "minimum" : 1,
            "example" : null
          },
          "redirect_url" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The url to redirect on successful checkout. Eg: https://yoursite.com/success.html?plan=basic\n",
            "maxLength" : 500,
            "example" : null
          },
          "enabled_in_hosted_pages" : {
            "type" : "boolean",
            "default" : true,
            "deprecated" : false,
            "description" : "If true, allow checkout through plan specific hosted page URL for this plan.\n",
            "example" : null
          },
          "enabled_in_portal" : {
            "type" : "boolean",
            "default" : true,
            "deprecated" : false,
            "description" : "If enabled, customers can switch to this plan using the 'Change Subscription' option in the customer portal.\n",
            "example" : null
          },
          "addon_applicability" : {
            "type" : "string",
            "default" : "all",
            "deprecated" : false,
            "description" : "Indicates if all or only some addons are applicable with the plan.\n\n* all - All addons are applicable with this plan.\n* restricted - Only addons marked as 'applicable_addons' are applicable with the plan.\n",
            "enum" : [ "all", "restricted" ],
            "example" : null
          },
          "tax_code" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The Avalara tax codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's [AvaTax for Sales integration](https://www.chargebee.com/docs/avalara.html)\n.\n",
            "maxLength" : 50,
            "example" : null
          },
          "hsn_code" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The [HSN code](https://cbic-gst.gov.in/gst-goods-services-rates.html)\nto which the item is mapped for calculating the customer's tax in India. Applicable only when both of the following conditions are true:\n\n* [**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.)\n* The [**AvaTax for Sales** integration](https://www.chargebee.com/docs/avalara.html) has been enabled in Chargebee.\n",
            "maxLength" : 50,
            "example" : null
          },
          "taxjar_product_code" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The TaxJar product codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's [TaxJar integration](https://www.chargebee.com/docs/taxjar.html)\n.\n",
            "maxLength" : 50,
            "example" : null
          },
          "avalara_sale_type" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Indicates the type of sale carried out. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html)\nintegration.\n\n* retail - Transaction is a sale to an end user\n* vendor_use - Transaction is for an item that is subject to vendor use tax\n* consumed - Transaction is for an item that is consumed directly\n* wholesale - Transaction is a sale to another company that will resell your product or service to another consumer\n",
            "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)\nintegration.\n",
            "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)\nintegration.\n",
            "example" : null
          },
          "sku" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The field is used as Product name/code in your third party accounting application. Chargebee will use it as an alternate name in your accounting application.\n",
            "maxLength" : 100,
            "example" : null
          },
          "accounting_code" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "This field is to capture the Account code setup in your Accounting system for integration purposes only.\n",
            "maxLength" : 100,
            "example" : null
          },
          "accounting_category1" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/1.0/finance-integration-index.html )\n\n* [**Xero:**](https://www.chargebee.com/docs/1.0/xero.html ) If you've categorized your products in Xero, provide the category name and option. Use the format: `:` . For example:`Location: Singapore.`\n* [**QuickBooks:**](https://www.chargebee.com/docs/1.0/quickbooks.html ) If you've categorized your product sales in QuickBooks according to Classes, provide the class name here. Use the following format: `::...`\n* [**NetSuite:**](https://www.chargebee.com/docs/1.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.`\n* [**Intacct:**](https://www.chargebee.com/docs/1.0/intacct.html ) If you've classified your products in Intacct under Locations, provide the name of the Location here.\n",
            "maxLength" : 100,
            "example" : null
          },
          "accounting_category2" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/1.0/finance-integration-index.html )\n\n* [**Xero:**](https://www.chargebee.com/docs/1.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`\n* [**QuickBooks:**](https://www.chargebee.com/docs/1.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`\n* [**NetSuite:**](https://www.chargebee.com/docs/1.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`\n* [**Intacct:**](https://www.chargebee.com/docs/1.0/intacct.html ) If you've classified your products in Intacct under Dimensions, provide the value of the Dimension here.\n",
            "maxLength" : 100,
            "example" : null
          },
          "accounting_category3" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Used exclusively with the following [accounting integrations](https://www.chargebee.com/docs/1.0/finance-integration-index.html )\n\n* [**NetSuite:**](https://www.chargebee.com/docs/1.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.`\n* [**Intacct:**](https://www.chargebee.com/docs/1.0/intacct.html ) If you've classified your products in Intacct under multiple Dimensions, provide the value of the second Dimension here.\n",
            "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 )\n\n* [**NetSuite:**](https://www.chargebee.com/docs/1.0/netsuite.html ) Provide the \"Revenue Recognition Rule Id\" for the product from NetSuite.\n* [**Intacct:**](https://www.chargebee.com/docs/1.0/intacct.html ) If you have configured \"Revenue Recognition Templates\" for products in Intacct, provide the template ID for the product.\n",
            "maxLength" : 100,
            "example" : null
          },
          "is_shippable" : {
            "type" : "boolean",
            "default" : false,
            "deprecated" : false,
            "description" : "If enabled, charges for this plan/addon will be added to orders.\n",
            "example" : null
          },
          "shipping_frequency_period" : {
            "type" : "integer",
            "format" : "int32",
            "deprecated" : false,
            "description" : "Defines the shipping frequency. Example: to bill customer every 2 weeks, provide \"2\" here.\n",
            "minimum" : 1,
            "example" : null
          },
          "shipping_frequency_period_unit" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Defines the shipping frequency in association with shipping period.\n\n* month - Ship based on month(s)\n* year - Ship based on year(s)\n* day - Ship based on day(s)\n* week - Ship based on week(s)\n",
            "enum" : [ "year", "month", "week", "day" ],
            "example" : null
          },
          "resource_version" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Version number of this resource. The `resource_version`\nis 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.\n",
            "example" : null
          },
          "updated_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp indicating when this plan was last updated. This attribute will be present only if the resource has been updated after 2016-11-09.\n",
            "example" : null
          },
          "giftable" : {
            "type" : "boolean",
            "default" : false,
            "deprecated" : false,
            "description" : "Specifies if the plan should be gifted or not.\n",
            "example" : null
          },
          "claim_url" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The url to redirect on successful claim. Eg: https://yoursite.com/claim_success.html?plan=basic\n",
            "maxLength" : 500,
            "example" : null
          },
          "free_quantity_in_decimal" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The quantity of the plan that is available free-of-charge, represented in decimal. When a subscription is created for this plan or when the plan of a subscription is changed to this one, only the quantity above this number is charged for. Applicable for quantity-based plans and only when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
            "maxLength" : 33,
            "example" : null
          },
          "price_in_decimal" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The price of the plan when the `pricing_model`\nis `flat_fee`.\nWhen the pricing model is `per_unit`\n, 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/v2/pcv-1/currencies)\nis enabled.\n",
            "maxLength" : 39,
            "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) 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
          },
          "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)\ndisplayed on the invoice PDF.\n",
            "maxLength" : 2000,
            "example" : null
          },
          "taxable" : {
            "type" : "boolean",
            "default" : true,
            "deprecated" : false,
            "description" : "Specifies whether taxes apply to this plan. This value is set and returned even if [Taxes](https://www.chargebee.com/docs/tax.html)\nhave been disabled in Chargebee. However, the value is effective only while Taxes are enabled.\n",
            "example" : null
          },
          "tax_profile_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Tax profile of the plan.\n",
            "maxLength" : 50,
            "example" : null
          },
          "meta_data" : {
            "type" : "object",
            "additionalProperties" : true,
            "deprecated" : false,
            "description" : "A collection of key-value pairs that provides extra information about the plan.  \n**Note:**\nThere's a character limit of 65,535.\n\n[Learn more](/docs/api/v2/pcv-1/advanced-features)\n.\n",
            "example" : null
          },
          "show_description_in_invoices" : {
            "type" : "boolean",
            "default" : false,
            "deprecated" : false,
            "description" : "Whether the [plan.description](/docs/api/v2/pcv-1/plans/plan-object)\nshould be shown on [invoice PDFs](/docs/api/invoices/retrieve-invoice-as-pdf).\nIf this Boolean is changed, only invoices generated (or [regenerated](https://www.chargebee.com/docs/billing/2.0/invoices-credit-notes-and-quotes/invoice-operations#actions-for-payment-due-not-paid-invoices)\n)after the change are affected; past invoices are not.\n",
            "example" : null
          },
          "show_description_in_quotes" : {
            "type" : "boolean",
            "default" : false,
            "deprecated" : false,
            "description" : "Whether the [plan description](/docs/api/v2/pcv-1/plans/plan-object)\nshould be shown on [quote PDFs](/docs/api/quotes/retrieve-quote-as-pdf).\nIf this Boolean is changed, only quotes created after the change are affected; past quotes are not.\n",
            "example" : null
          },
          "tiers" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "List of tiers for this plan(applicable only if it is tiered/volume/stairtstep pricing)\n",
            "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\n",
                  "minimum" : 1,
                  "example" : null
                },
                "ending_unit" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "description" : "The upper limit of a range of units for the tier\n",
                  "example" : null
                },
                "price" : {
                  "type" : "integer",
                  "format" : "int64",
                  "default" : 0,
                  "deprecated" : false,
                  "description" : "The per-unit price for the tier when the `pricing_model`\nis `tiered`\nor `volume`\n; the total cost for the item price when the `pricing_model`\nis `stairstep`.\nThe value is in the [minor unit of the currency](/docs/api/v2/pcv-1/currencies)\n.\n",
                  "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`\nof the next lower tier. Returned only when the `pricing_model`\nis `tiered`\n, `volume`\nor `stairstep`\nand [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "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`\nof the next higher tier. Returned only when the `pricing_model`\nis `tiered`\n, `volume`\nor `stairstep`\nand [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "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`\nis `tiered`\nor `volume`.\nWhen the `pricing_model`\nis `stairstep`\n, 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/v2/pcv-1/currencies)\nis enabled.\n",
                  "maxLength" : 39,
                  "example" : null
                },
                "pricing_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "enum" : [ "per_unit", "flat_fee", "package" ],
                  "example" : null
                },
                "package_size" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "minimum" : 1,
                  "example" : null
                }
              },
              "required" : [ "price", "starting_unit" ],
              "example" : null
            },
            "example" : null
          },
          "tax_providers_fields" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "List of vendor specific tax related information.\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "provider_name" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Name of the tax provider currently we support.\n",
                  "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.\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "field_value" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The value of the corresponding tax field.\n",
                  "maxLength" : 50,
                  "example" : null
                }
              },
              "required" : [ "field_id", "field_value", "provider_name" ],
              "example" : null
            },
            "example" : null
          },
          "applicable_addons" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "List of addons applicable with this plan.\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Identifier of the addon appplicable to the plan.\n",
                  "maxLength" : 100,
                  "example" : null
                }
              },
              "required" : [ "id" ],
              "example" : null
            },
            "example" : null
          },
          "attached_addons" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "Indicates if the addon is attached with the plan as mandatory or recommended.\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Identifier of the addon attached with the plan. Only recurring addons can be attached with the plan.\n",
                  "maxLength" : 100,
                  "example" : null
                },
                "quantity" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                  "minimum" : 1,
                  "example" : null
                },
                "billing_cycles" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "description" : "The number of billing cycles this addon will be attached to the plan.\n",
                  "minimum" : 1,
                  "example" : null
                },
                "type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Specifies attachment type of the addon to the plan\n\n* recommended - Addon will be charged with this plan unless specifically removed.\n* mandatory - Addon will be always charged with this plan.\n",
                  "enum" : [ "recommended", "mandatory" ],
                  "example" : null
                },
                "quantity_in_decimal" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The decimal representation of the quantity of the addon. Returned for quantity-based addons when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "maxLength" : 33,
                  "example" : null
                }
              },
              "required" : [ "id", "quantity", "type" ],
              "example" : null
            },
            "example" : null
          },
          "event_based_addons" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "List of addons that will be charged on occurrence of specific event on subscribing to the plan.\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Identifier of the addon. Multiple addons can be passed.\n",
                  "maxLength" : 100,
                  "example" : null
                },
                "quantity" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                  "minimum" : 1,
                  "example" : null
                },
                "on_event" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Event on which the addon will be charged\n\n* plan_activation - Addon will be charged on plan activation.\n* contract_termination - Addon will be charged on contract termination.\n* subscription_activation - Addon will be charged on subscription activation.\n* subscription_creation - Addon will be charged on subscription creation.\n* subscription_trial_start - Addon will be charged when the trial period starts.\n",
                  "enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ],
                  "example" : null
                },
                "charge_once" : {
                  "type" : "boolean",
                  "default" : true,
                  "deprecated" : false,
                  "description" : "If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.\n",
                  "example" : null
                },
                "quantity_in_decimal" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The decimal representation of the quantity of the addon. Returned for quantity-based addons when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "maxLength" : 33,
                  "example" : null
                }
              },
              "required" : [ "charge_once", "id", "on_event", "quantity" ],
              "example" : null
            },
            "example" : null
          }
        },
        "required" : [ "addon_applicability", "currency_code", "enabled_in_hosted_pages", "enabled_in_portal", "free_quantity", "giftable", "id", "name", "period", "period_unit", "pricing_model", "status" ],
        "example" : null
      },
      "PlanCreatedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "plan" : {
                "$ref" : "#/components/schemas/Plan"
              }
            },
            "required" : [ "plan" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "PlanDeletedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "plan" : {
                "$ref" : "#/components/schemas/Plan"
              }
            },
            "required" : [ "plan" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "PlanUpdatedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "plan" : {
                "$ref" : "#/components/schemas/Plan"
              }
            },
            "required" : [ "plan" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "PlatformAccount" : {
        "type" : "object",
        "description" : "Represents a platform account in Chargebee.\nEach platform account includes a unique `id` and can optionally include `partner_name` and `partner_description`.\n",
        "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.\n",
            "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.\n",
            "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.\n",
            "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/billing/2.0/hosted-capabilities/self-serve-portal#access-the-self-serve-portal).\n\nPlease follow the below steps for supporting portal access via SSO:\n\n1. Enable the \"Allow access to customer portal via API\" under \"Settings \\> Hosted Pages Settings \\> Customer Portal\" to use the portal sessions API.\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.\n\n#### Using Chargebee's authentication\n\n**Note:** This feature is not supported in [in-app](https://www.chargebee.com/docs/inapp-self-serve-portal.html) portal.\nChargebee 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/v2/pcv-1/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.\n",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Unique identifier for the portal session.\n",
            "maxLength" : 70,
            "example" : null
          },
          "token" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Unique pre-authenticated portal session token to access customer portal directly.\n",
            "maxLength" : 70,
            "example" : null
          },
          "access_url" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Unique URL for accessing the customer portal. Once accessed, this cannot be reused.\n",
            "maxLength" : 550,
            "example" : null
          },
          "redirect_url" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "URL to redirect when the user logs out from the portal.\n",
            "maxLength" : 250,
            "example" : null
          },
          "status" : {
            "type" : "string",
            "default" : "created",
            "deprecated" : false,
            "description" : "Indicates the current status of the portal session.\n\n* 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\n* 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.\n* logged_in - Indicates that the portal session URL has been accessed by the user and the session is active.\n* created - Indicates that the portal session is just created and not yet accessed by the user.\n* logged_out - Indicates that the portal session is logged out either by user or via API.\n",
            "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.\n",
            "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.\n",
            "example" : null
          },
          "customer_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Identifier of the customer.\n",
            "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.\n",
            "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.\n",
            "example" : null
          },
          "login_ipaddress" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "IP Address from which the portal session URL was accessed.\n",
            "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.\n",
            "maxLength" : 50,
            "example" : null
          },
          "linked_customers" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "The list of customers for this session\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "customer_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Identifier of the customer.\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.\n",
                  "maxLength" : 70,
                  "example" : null
                },
                "has_billing_address" : {
                  "type" : "boolean",
                  "default" : false,
                  "deprecated" : false,
                  "description" : "The customer has billing address.\n",
                  "example" : null
                },
                "has_payment_method" : {
                  "type" : "boolean",
                  "default" : false,
                  "deprecated" : false,
                  "description" : "The customer has payment method.\n",
                  "example" : null
                },
                "has_active_subscription" : {
                  "type" : "boolean",
                  "default" : false,
                  "deprecated" : false,
                  "description" : "The customer has atleast one active subscription.\n",
                  "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
      },
      "PricingModel" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "flat_fee", "per_unit", "tiered", "volume", "stairstep" ],
        "example" : null
      },
      "PricingPageSession" : {
        "type" : "object",
        "description" : "**Important:**\nThis recource does not support product catalog 1.0. Navigate to the correct [version](/docs/api/pricing_page_sessions).\n",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Unique identifier generated for each pricing page session requested.\n",
            "maxLength" : 70,
            "example" : null
          },
          "url" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Unique URL for the pricing page that will be included in your website.\n",
            "maxLength" : 250,
            "example" : null
          },
          "created_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Indicates when this pricing page session is generated.\n",
            "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.\n",
            "example" : null
          }
        },
        "example" : null
      },
      "PricingType" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "per_unit", "flat_fee", "package" ],
        "example" : null
      },
      "ProductCatalogVersion" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "v1", "v2" ],
        "example" : null
      },
      "PromotionalCredit" : {
        "type" : "object",
        "description" : "These credits can be provided to the customer for promoting the product. You can use Promotional Credits to offer referral bonuses, cash back offers and more. When a customer has promotional credits, it is automatically applied whenever a new invoice is created.\n",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Unique reference ID provided for promotional credits\n",
            "maxLength" : 150,
            "example" : null
          },
          "customer_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Identifier of the customer.\n",
            "maxLength" : 50,
            "example" : null
          },
          "type" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Type of promotional credits\n\n* decrement - Decrement\n* increment - Increment\n",
            "enum" : [ "increment", "decrement" ],
            "example" : null
          },
          "amount_in_decimal" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Amount in decimal\n",
            "maxLength" : 33,
            "example" : null
          },
          "amount" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Promotional credits amount\n",
            "minimum" : 0,
            "example" : null
          },
          "currency_code" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The currency code (ISO 4217 format) for promotional credit\n",
            "maxLength" : 3,
            "example" : null
          },
          "description" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Detailed description of this promotional credits.\n",
            "maxLength" : 250,
            "example" : null
          },
          "credit_type" : {
            "type" : "string",
            "default" : "general",
            "deprecated" : false,
            "description" : "Type of promotional credits provided to customer\n\n* referral_rewards - Referral\n* loyalty_credits - Loyalty Credits\n* general - General\n",
            "enum" : [ "loyalty_credits", "referral_rewards", "general" ],
            "example" : null
          },
          "reference" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Describes why promotional credits were provided\n",
            "maxLength" : 500,
            "example" : null
          },
          "closing_balance" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Closing balance as on end date.\n",
            "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.\n",
            "maxLength" : 100,
            "example" : null
          },
          "created_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp indicating when this promotional credit resource is created.\n",
            "example" : null
          },
          "business_entity_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity.\n\n**Note** [Multiple Business Entities](/docs/api/business_entities) is a feature available only on Product Catalog 2.0.\n",
            "maxLength" : 50,
            "example" : null
          }
        },
        "required" : [ "amount", "closing_balance", "created_at", "credit_type", "currency_code", "customer_id", "description", "id", "type" ],
        "example" : null
      },
      "PromotionalCreditsAddedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "promotional_credit" : {
                "$ref" : "#/components/schemas/PromotionalCredit"
              }
            },
            "required" : [ "customer", "promotional_credit" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "PromotionalCreditsDeductedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "promotional_credit" : {
                "$ref" : "#/components/schemas/PromotionalCredit"
              }
            },
            "required" : [ "customer", "promotional_credit" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "ProrationType" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "full_term", "partial_term", "none" ],
        "example" : null
      },
      "Quote" : {
        "type" : "object",
        "additionalProperties" : true,
        "description" : "A quote is an estimate of the invoice with the charges likely to occur when customers buy an item. A quote can be converted to a regular invoice once the customer accepts it.\n\nThe 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.\n",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The quote number. Acts as a identifier for quote and typically generated sequentially.\n",
            "maxLength" : 50,
            "example" : null
          },
          "name" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The quote name will be used as the pdf name of the quote.\n",
            "maxLength" : 100,
            "example" : null
          },
          "po_number" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Purchase Order Number\n",
            "maxLength" : 100,
            "example" : null
          },
          "customer_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The identifier of the customer this quote belongs to.\n",
            "maxLength" : 50,
            "example" : null
          },
          "subscription_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The identifier of the subscription this quote belongs to.\n",
            "maxLength" : 50,
            "example" : null
          },
          "invoice_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The identifier of the invoice generated while converting this quote.\n",
            "maxLength" : 50,
            "example" : null
          },
          "status" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Current status of this quote.\n\n* open - Open\n* closed - Closed\n* declined - Declined.\n* invoiced - Invoiced\n* voided - Voided.\n* accepted - Accepted.\n* proposed - Proposed.\n* expired - Expired\n* approval_rejected - Approval Rejected\n* pending_approval - Pending Approval\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\n\n* onetime_invoice - onetime_invoice\n* change_subscription - change_subscription\n* renew_subscription - renew_subscription\n* create_subscription_for_customer - create_subscription_for_customer\n",
            "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)\n",
            "maxLength" : 20,
            "example" : null
          },
          "price_type" : {
            "type" : "string",
            "default" : "tax_exclusive",
            "deprecated" : false,
            "description" : "The price type of the quote.\n\n* tax_inclusive - All amounts in the document are inclusive of tax.\n* tax_exclusive - All amounts in the document are exclusive of tax.\n",
            "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.\n",
            "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.\n",
            "example" : null
          },
          "total_payable" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Total contract value. Applicable when multi billing cycle quote is enabled.\n",
            "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.\n",
            "minimum" : 0,
            "example" : null
          },
          "sub_total" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Subtotal (in cents) of the first quote line group.\n",
            "minimum" : 0,
            "example" : null
          },
          "total" : {
            "type" : "integer",
            "format" : "int64",
            "default" : 0,
            "deprecated" : false,
            "description" : "Total (in cents) of the first quote line group.\n",
            "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.\n",
            "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.\n",
            "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.\n",
            "minimum" : 0,
            "example" : null
          },
          "version" : {
            "type" : "integer",
            "format" : "int32",
            "default" : 1,
            "deprecated" : false,
            "description" : "Version of the quote.\n",
            "example" : null
          },
          "resource_version" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Version number of this resource. The `resource_version`\nis 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.\n",
            "example" : null
          },
          "updated_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp indicating when this quote was last updated.\n",
            "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).\nOnly applicable specifically for customers with [billing_address](/docs/api/customers/customer-object#billing_address)\n\n`country`\nas `XI`\n(which is **United Kingdom - Northern Ireland**\n).\n\nWhen you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html)\nin 2021 or have [manually enabled](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee)\nthe Brexit configuration, you have the option of setting [billing_address](/docs/api/customers/customer-object#billing_address)\n\n`country`\nas `XI`.\nThat's the code for **United Kingdom - Northern Ireland** .\nThe first two characters of the VAT number in such a case is\n`XI`\nby default. However, if the VAT number was registered in UK, the value should be `GB`.\nSet\n`vat_number_prefix`\nto `GB`\nfor such cases.\n",
            "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.\n",
            "example" : null
          },
          "currency_code" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The currency code (ISO 4217 format) of the quote.\n",
            "maxLength" : 3,
            "example" : null
          },
          "notes" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "List of notes associated with this quotes.\n",
            "items" : {
              "example" : null
            },
            "example" : null
          },
          "contract_term_start" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Specifies the contract term's start date.\n",
            "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`\ngets triggered.\n",
            "example" : null
          },
          "contract_term_termination_fee" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Specifies the charge to be applied for terminating the contract term.\n",
            "minimum" : 0,
            "example" : null
          },
          "business_entity_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity.  \n**Note**\n\n[Multiple Business Entities](/docs/api/getting-started) is a feature available only on Product Catalog 2.0.\n",
            "maxLength" : 50,
            "example" : null
          },
          "deleted" : {
            "type" : "boolean",
            "deprecated" : false,
            "description" : "Indicates that this resource has been deleted when the value is `true`\n.\n",
            "example" : null
          },
          "total_contract_value" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "The total contract value of the quote.\n",
            "minimum" : 0,
            "example" : null
          },
          "total_discount" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "The total discount value of the quote for the contract period.\n",
            "minimum" : 0,
            "example" : null
          },
          "has_entitlements" : {
            "type" : "boolean",
            "deprecated" : false,
            "example" : null
          },
          "line_items" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "The list of line items for this quote.\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Uniquely identifies a line_item\n",
                  "maxLength" : 40,
                  "example" : null
                },
                "subscription_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "A unique identifier for the subscription this line item belongs to.\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "date_from" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "Start date of this line item.\n",
                  "example" : null
                },
                "date_to" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "End date of this line item.\n",
                  "example" : null
                },
                "unit_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Unit amount of the line item.\n",
                  "example" : null
                },
                "quantity" : {
                  "type" : "integer",
                  "format" : "int32",
                  "default" : 1,
                  "deprecated" : false,
                  "description" : "[Quantity of the recurring item](/docs/api/v2/pcv-1/invoices/invoice-object#line_items_quantity)\nwhich is represented by this line item.\n",
                  "example" : null
                },
                "amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Total amount of this line item. Typically equals to unit amount x quantity\n",
                  "example" : null
                },
                "pricing_model" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The [pricing scheme](https://www.chargebee.com/docs/plans.html#pricing-attributes_pricing-model)\nfor this item.\n\n* per_unit - A fixed price per unit quantity.\n* stairstep - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.\n* flat_fee - A fixed price that is not quantity-based.\n* tiered - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.\n* volume - The per unit price is based on the tier that the total quantity falls in.\n",
                  "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\n",
                  "example" : null
                },
                "tax_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "default" : 0,
                  "deprecated" : false,
                  "description" : "The tax amount charged for this item\n",
                  "minimum" : 0,
                  "example" : null
                },
                "tax_rate" : {
                  "type" : "number",
                  "format" : "double",
                  "deprecated" : false,
                  "description" : "Rate of tax used to calculate tax for this lineitem\n",
                  "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`.\nThe value is in major units of the currency. Returned when the `line_item`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "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`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "maxLength" : 33,
                  "example" : null
                },
                "amount_in_decimal" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The decimal representation of the amount for the `line_item`\n, in major units of the currency. Typically equals to `unit_amount_in_decimal`\nx `quantity_in_decimal`.\nReturned when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "maxLength" : 39,
                  "example" : null
                },
                "discount_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Total discounts for this line\n",
                  "minimum" : 0,
                  "example" : null
                },
                "item_level_discount_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Line Item-level discounts for this line.\n",
                  "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.\n",
                  "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\n",
                  "maxLength" : 40,
                  "example" : null
                },
                "description" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Detailed description about this line item.\n",
                  "maxLength" : 250,
                  "example" : null
                },
                "entity_description" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Detailed description about this item.\n",
                  "maxLength" : 2000,
                  "example" : null
                },
                "entity_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Specifies the modelled entity this line item is based on.\n\n* addon -\n  Indicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the [addon](/docs/api/v2/pcv-1/addons/addon-object)\n  id\n* adhoc - Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case\n* plan_setup -\n  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)\n  id\n* plan -\n  Indicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)\n  id\n",
                  "enum" : [ "plan_setup", "plan", "addon", "adhoc" ],
                  "example" : null
                },
                "tax_exempt_reason" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The reason due to which the line item price/amount is exempted from tax.\n\n* 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.\n* reverse_charge - If the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU only\n* tax_not_configured - If tax is not enabled for the site\n* 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\n* product_exempt - If the Plan or Addon is marked as Tax exempt\n* zero_rated - If the rate of tax is 0% and no Sales/ GST tax is collectable for that line item\n* tax_not_configured_external_provider - If the tax is not configured for the country in 3rd party tax provider.\n* customer_exempt - If the Customer is marked as Tax exempt\n* 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\n* export -\n  You are not registered for tax in the customer's region. This is also the reason code when both `billing_address`\n  and `shipping_address`\n  have not been provided for the customer and subscription respectively\n",
                  "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\n",
                  "maxLength" : 100,
                  "example" : null
                },
                "customer_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "A unique identifier for the customer this line item belongs to\n",
                  "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.\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "line_item_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Uniquely identifies a line_item\n",
                  "maxLength" : 40,
                  "example" : null
                },
                "starting_unit" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "description" : "The lower limit of a range of units for the tier\n",
                  "minimum" : 0,
                  "example" : null
                },
                "ending_unit" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "description" : "The upper limit of a range of units for the tier\n",
                  "example" : null
                },
                "quantity_used" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "description" : "The number of units purchased in a range.\n",
                  "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`\npricing , or the price of each unit in the tier if the charge model is `tiered`\n/`volume`\npricing.\n",
                  "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`\nof the next lower tier. Returned only when the `line_items.pricing_model`\nis `tiered`\n, `volume`\nor `stairstep`\nand [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "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`\nof the next higher tier. Returned only when the `line_items.pricing_model`\nis `tiered`\n, `volume`\nor stairstep and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "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`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "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`\nis `tiered`\nor `volume`.\nWhen the `pricing_model`\nis `stairstep`\n, it is the decimal representation of the total price for `line_item`.\nThe value is in major units of the currency. Returned when the `line_item`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "maxLength" : 40,
                  "example" : null
                },
                "pricing_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "enum" : [ "per_unit", "flat_fee", "package" ],
                  "example" : null
                },
                "package_size" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "minimum" : 1,
                  "example" : null
                }
              },
              "required" : [ "quantity_used", "starting_unit", "unit_amount" ],
              "example" : null
            },
            "example" : null
          },
          "line_item_discounts" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "The list of deductions applied for each line item of this quote.\n",
            "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.\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "discount_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The type of deduction and the amount to which it is applied.\n\n* item_level_coupon -\n  The deduction is due to a coupon applied to a line item of the invoice. The coupon `id`\n  is available as `entity_id`\n  .\n* prorated_credits -\n  The deduction is due to a legacy adjustment credit applied to the invoice. The `entity_id`\n  is `null`\n  in this case. The legacy credits feature is superseded by [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)\n  .\n* document_level_coupon -\n  The deduction is due to a coupon applied to the invoice `sub_total`.\n  The coupon `id`\n  is available as `entity_id`\n  .\n* promotional_credits -\n  The deduction is due to a [promotional credit](/docs/api/promotional_credits)\n  applied to the invoice. The `entity_id`\n  is `null`\n  in this case.\n",
                  "enum" : [ "item_level_coupon", "document_level_coupon", "promotional_credits", "prorated_credits" ],
                  "example" : null
                },
                "coupon_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "When the deduction is due to a coupon, then this is the id of the coupon.\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "entity_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 50,
                  "example" : null
                },
                "discount_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "The amount deducted. The format of this value depends on the [kind of currency](/docs/api/currencies)\n.\n",
                  "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.\n",
            "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\n",
                  "maxLength" : 40,
                  "example" : null
                },
                "tax_name" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The name of the tax applied\n",
                  "maxLength" : 100,
                  "example" : null
                },
                "tax_rate" : {
                  "type" : "number",
                  "format" : "double",
                  "default" : 0,
                  "deprecated" : false,
                  "description" : "The rate of tax used to calculate tax amount\n",
                  "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.\n",
                  "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.\n",
                  "example" : null
                },
                "prorated_taxable_amount" : {
                  "type" : "number",
                  "format" : "decimal",
                  "deprecated" : false,
                  "description" : "Indicates the prorated line item amount in cents.\n",
                  "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.\n",
                  "example" : null
                },
                "is_non_compliance_tax" : {
                  "type" : "boolean",
                  "deprecated" : false,
                  "description" : "Indicates the non-compliance tax that should not be reported to the jurisdiction.\n",
                  "example" : null
                },
                "taxable_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Indicates the actual portion of the line item amount that is taxable.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "tax_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "The tax amount\n",
                  "minimum" : 0,
                  "example" : null
                },
                "tax_juris_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The type of tax jurisdiction\n\n* unincorporated - Combined tax of state and county.\n* federal - The tax jurisdiction is a federal\n* state - The tax jurisdiction is a state\n* county - The tax jurisdiction is a county\n* country - The tax jurisdiction is a country\n* city - The tax jurisdiction is a city\n* other - Jurisdictions other than the ones listed above.\n* special - Special tax jurisdiction.\n",
                  "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\n",
                  "maxLength" : 250,
                  "example" : null
                },
                "tax_juris_code" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The tax jurisdiction code\n",
                  "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.\n",
                  "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.\n",
                  "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.\n",
            "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)\n.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "description" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Description for this deduction.\n",
                  "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]`\nis `item_level_coupon`\nor `document_level_coupon`\n.\n",
                  "maxLength" : 40,
                  "example" : null
                },
                "entity_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The type of deduction and the amount to which it is applied.\n\n* document_level_coupon -\n  The deduction is due to a coupon applied to the invoice `sub_total`.\n  The coupon id is passed as `entity_id`\n  .\n* prorated_credits -\n  The deduction is due to a legacy adjustment credit applied to the invoice. The `entity_id`\n  is `null`\n  in this case. The legacy credits feature is superseded by [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)\n  .\n* item_level_coupon -\n  The deduction is due to a coupon applied to line item. The coupon `id`\n  is passed as `entity_id`\n  .\n* promotional_credits -\n  The deduction is due to a [promotional credit](/docs/api/promotional_credits)\n  applied to the invoice.\n",
                  "enum" : [ "item_level_coupon", "document_level_coupon", "promotional_credits", "prorated_credits" ],
                  "example" : null
                },
                "discount_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "enum" : [ "fixed_amount", "percentage" ],
                  "example" : null
                },
                "entity_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "When the deduction is due to a `coupon`\n, then this is the `id`\nof the coupon.\n",
                  "maxLength" : 100,
                  "example" : null
                },
                "coupon_set_code" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The [coupon code](/docs/api/coupon_codes/coupon_code-object#code)\n, if applicable, used to provide the discount. The [coupon.id](/docs/api/coupons/coupon-object#id)\nis available in `entity_id`\n.\n",
                  "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.\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "name" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The name of the tax applied. E.g. GST.\n",
                  "maxLength" : 100,
                  "example" : null
                },
                "amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "The tax amount.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "description" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Description of the tax item.\n",
                  "maxLength" : 250,
                  "example" : null
                }
              },
              "required" : [ "amount", "name" ],
              "example" : null
            },
            "example" : null
          },
          "shipping_address" : {
            "type" : "object",
            "deprecated" : false,
            "description" : "Shipping address for the quote.\n",
            "properties" : {
              "first_name" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The first name of the contact.\n",
                "maxLength" : 150,
                "example" : null
              },
              "last_name" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The last name of the contact.\n",
                "maxLength" : 150,
                "example" : null
              },
              "email" : {
                "type" : "string",
                "format" : "email",
                "deprecated" : false,
                "description" : "The email address.\n",
                "maxLength" : 70,
                "example" : null
              },
              "company" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The company name.\n",
                "maxLength" : 250,
                "example" : null
              },
              "phone" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The phone number.\n",
                "maxLength" : 50,
                "example" : null
              },
              "line1" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Address line 1\n",
                "maxLength" : 150,
                "example" : null
              },
              "line2" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Address line 2\n",
                "maxLength" : 150,
                "example" : null
              },
              "line3" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Address line 3\n",
                "maxLength" : 150,
                "example" : null
              },
              "city" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                "maxLength" : 50,
                "example" : null
              },
              "state" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The state/province name.\n",
                "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)\n.\n",
                "maxLength" : 20,
                "example" : null
              },
              "validation_status" : {
                "type" : "string",
                "default" : "not_validated",
                "deprecated" : false,
                "description" : "The address verification status.\n\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n* valid - Address was validated successfully.\n",
                "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                "example" : null
              }
            },
            "example" : null
          },
          "billing_address" : {
            "type" : "object",
            "deprecated" : false,
            "description" : "Billing address for the quote.\n",
            "properties" : {
              "first_name" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The first name of the billing contact.\n",
                "maxLength" : 150,
                "example" : null
              },
              "last_name" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The last name of the billing contact.\n",
                "maxLength" : 150,
                "example" : null
              },
              "email" : {
                "type" : "string",
                "format" : "email",
                "deprecated" : false,
                "description" : "The email address.\n",
                "maxLength" : 70,
                "example" : null
              },
              "company" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The company name.\n",
                "maxLength" : 250,
                "example" : null
              },
              "phone" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The phone number.\n",
                "maxLength" : 50,
                "example" : null
              },
              "line1" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Address line 1\n",
                "maxLength" : 150,
                "example" : null
              },
              "line2" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Address line 2\n",
                "maxLength" : 150,
                "example" : null
              },
              "line3" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Address line 3\n",
                "maxLength" : 150,
                "example" : null
              },
              "city" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                "maxLength" : 50,
                "example" : null
              },
              "state" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "State or Province\n",
                "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)\n.\n",
                "maxLength" : 20,
                "example" : null
              },
              "validation_status" : {
                "type" : "string",
                "default" : "not_validated",
                "deprecated" : false,
                "description" : "The address verification status.\n\n* valid - Address was validated successfully.\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n* not_validated - Address is not yet validated.\n",
                "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                "example" : null
              }
            },
            "example" : null
          }
        },
        "required" : [ "currency_code", "customer_id", "date", "deleted", "id", "operation_type", "price_type", "status", "sub_total", "valid_till" ],
        "example" : null
      },
      "QuoteCreatedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "quote" : {
                "$ref" : "#/components/schemas/Quote"
              }
            },
            "required" : [ "quote" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "QuoteDeletedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "quote" : {
                "$ref" : "#/components/schemas/Quote"
              }
            },
            "required" : [ "quote" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "QuoteEntitlement" : {
        "type" : "object",
        "properties" : {
          "entity_id" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 100,
            "example" : null
          },
          "entity_type" : {
            "type" : "string",
            "deprecated" : false,
            "enum" : [ "plan_price", "addon_price", "charge_price" ],
            "example" : null
          },
          "feature_id" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 50,
            "example" : null
          },
          "value" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 50,
            "example" : null
          },
          "is_enabled" : {
            "type" : "boolean",
            "default" : true,
            "deprecated" : false,
            "example" : null
          },
          "start_date" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "example" : null
          },
          "end_date" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "example" : null
          },
          "created_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "example" : null
          },
          "modified_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "example" : null
          },
          "is_overridden" : {
            "type" : "boolean",
            "deprecated" : false,
            "example" : null
          },
          "feature_name" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 50,
            "example" : null
          },
          "feature_unit" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 50,
            "example" : null
          },
          "feature_type" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 50,
            "example" : null
          },
          "name" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 50,
            "example" : null
          },
          "metered" : {
            "type" : "boolean",
            "deprecated" : false,
            "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.\n\nConsider the following:\n\n* A monthly plan A for $500 per month.\n* 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:\n\n#### Quote Line group 1\n\n**Plan A:**\n$500\n\n**Addon B:**\n$50\n\n**Total:**\n$550\n\n#### Quote Line group 2\n\n**Plan A:**\n$500\n\n**Total:**\n$500\n\n#### Quote Line group 3\n\n**Plan A:**\n$500\n\n**Total:**\n$500\n",
        "properties" : {
          "version" : {
            "type" : "integer",
            "format" : "int32",
            "default" : 1,
            "deprecated" : false,
            "description" : "Version of the quote line group.\n",
            "example" : null
          },
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Uniquely identifies a quote line group.\n",
            "maxLength" : 40,
            "example" : null
          },
          "sub_total" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Subtotal in cents.\n",
            "minimum" : 0,
            "example" : null
          },
          "total" : {
            "type" : "integer",
            "format" : "int64",
            "default" : 0,
            "deprecated" : false,
            "description" : "Total in cents.\n",
            "minimum" : 0,
            "example" : null
          },
          "credits_applied" : {
            "type" : "integer",
            "format" : "int64",
            "default" : 0,
            "deprecated" : false,
            "description" : "Credits (in cents) applied to this quote line group.\n",
            "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.\n",
            "minimum" : 0,
            "example" : null
          },
          "amount_due" : {
            "type" : "integer",
            "format" : "int64",
            "default" : 0,
            "deprecated" : false,
            "description" : "Amount due in cents\n",
            "minimum" : 0,
            "example" : null
          },
          "charge_event" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Describes the time in the subscription lifecycle when the charge is to occur.\n\n* subscription_creation - Subscription Creation\n* trial_start - Trial Start\n* subscription_renewal - Subscription Renewal\n* subscription_change - Subscription Change\n* subscription_cancel - Subscription Cancel\n* immediate - Immediate\n",
            "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.\n",
            "example" : null
          },
          "line_items" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "The list of items in this quote line group.\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Uniquely identifies a line_item\n",
                  "maxLength" : 40,
                  "example" : null
                },
                "subscription_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "A unique identifier for the subscription this line item belongs to.\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "date_from" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "Start date of this line item.\n",
                  "example" : null
                },
                "date_to" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "End date of this line item.\n",
                  "example" : null
                },
                "unit_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Unit amount of the line item.\n",
                  "example" : null
                },
                "quantity" : {
                  "type" : "integer",
                  "format" : "int32",
                  "default" : 1,
                  "deprecated" : false,
                  "description" : "[Quantity of the recurring item](/docs/api/v2/pcv-1/invoices/invoice-object#line_items_quantity)\nwhich is represented by this line item.\n",
                  "example" : null
                },
                "amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Total amount of this line item. Typically equals to unit amount x quantity\n",
                  "example" : null
                },
                "pricing_model" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The\n[pricing scheme](https://www.chargebee.com/docs/plans.html#pricing-attributes_pricing-model)\nfor this item.\n\n* per_unit - A fixed price per unit quantity.\n* stairstep - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.\n* flat_fee - A fixed price that is not quantity-based.\n* tiered - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.\n* volume - The per unit price is based on the tier that the total quantity falls in.\n",
                  "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\n",
                  "example" : null
                },
                "tax_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "default" : 0,
                  "deprecated" : false,
                  "description" : "The tax amount charged for this item\n",
                  "minimum" : 0,
                  "example" : null
                },
                "tax_rate" : {
                  "type" : "number",
                  "format" : "double",
                  "deprecated" : false,
                  "description" : "Rate of tax used to calculate tax for this lineitem\n",
                  "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`.\nThe value is in major units of the currency. Returned when the `line_item`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "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`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "maxLength" : 33,
                  "example" : null
                },
                "amount_in_decimal" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The decimal representation of the amount for the `line_item`\n, in major units of the currency. Typically equals to `unit_amount_in_decimal`\nx `quantity_in_decimal`.\nReturned when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "maxLength" : 39,
                  "example" : null
                },
                "discount_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Total discounts for this line\n",
                  "minimum" : 0,
                  "example" : null
                },
                "item_level_discount_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Line Item-level discounts for this line.\n",
                  "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\n",
                  "maxLength" : 40,
                  "example" : null
                },
                "description" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Detailed description about this line item.\n",
                  "maxLength" : 250,
                  "example" : null
                },
                "entity_description" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Detailed description about this item.\n",
                  "maxLength" : 2000,
                  "example" : null
                },
                "entity_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Specifies the modelled entity this line item is based on.\n\n* addon -\n  Indicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the [addon](/docs/api/v2/pcv-1/addons/addon-object)\n  id\n* plan_item_price - Indicates that this line item is based on plan Item Price\n* addon_item_price - Indicates that this line item is based on addon Item Price\n* charge_item_price - Indicates that this line item is based on charge Item Price\n* adhoc - Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case\n* plan_setup -\n  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)\n  id\n* plan -\n  Indicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)\n  id\n",
                  "enum" : [ "plan_setup", "plan", "addon", "adhoc" ],
                  "example" : null
                },
                "tax_exempt_reason" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The reason due to which the line item price/amount is exempted from tax.\n\n* reverse_charge - If the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU only\n* tax_not_configured - If tax is not enabled for the site\n* 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\n* product_exempt - If the Plan or Addon is marked as Tax exempt\n* zero_rated - If the rate of tax is 0% and no Sales/ GST tax is collectable for that line item\n* customer_exempt - If the Customer is marked as Tax exempt\n* 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\n* export -\n  You are not registered for tax in the customer's region. This is also the reason code when both `billing_address`\n  and `shipping_address`\n  have not been provided for the customer and subscription respectively\n",
                  "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\n",
                  "maxLength" : 100,
                  "example" : null
                },
                "customer_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "A unique identifier for the customer this line item belongs to\n",
                  "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.\n",
            "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.\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "discount_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The type of deduction and the amount to which it is applied.\n\n* item_level_coupon -\n  The deduction is due to a coupon applied to a line item of the invoice. The coupon `id`\n  is available as `entity_id`\n  .\n* prorated_credits -\n  The deduction is due to a legacy adjustment credit applied to the invoice. The `entity_id`\n  is `null`\n  in this case. The legacy credits feature is superseded by [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)\n  .\n* document_level_coupon -\n  The deduction is due to a coupon applied to the invoice `sub_total`.\n  The coupon `id`\n  is available as `entity_id`\n  .\n* document_level_discount -\n  The deduction is due to a [discount](/docs/api/discounts)\n  applied to the invoice `sub_total`.\n  The discount `id`\n  is available as the `entity_id`.\n* item_level_discount -\n  The deduction is due to a [discount](/docs/api/discounts)\n  applied to a line item of the invoice. The discount `id`\n  is available as the `entity_id`.\n* promotional_credits -\n  The deduction is due to a [promotional credit](/docs/api/promotional_credits)\n  applied to the invoice. The `entity_id`\n  is `null`\n  in this case.\n",
                  "enum" : [ "item_level_coupon", "document_level_coupon", "promotional_credits", "prorated_credits" ],
                  "example" : null
                },
                "coupon_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "When the deduction is due to a coupon, then this is the id of the coupon.\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "entity_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 50,
                  "example" : null
                },
                "discount_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "The amount deducted. The format of this value depends on the [kind of currency](/docs/api/currencies)\n.\n",
                  "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.\n",
            "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\n",
                  "maxLength" : 40,
                  "example" : null
                },
                "tax_name" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The name of the tax applied\n",
                  "maxLength" : 100,
                  "example" : null
                },
                "tax_rate" : {
                  "type" : "number",
                  "format" : "double",
                  "default" : 0,
                  "deprecated" : false,
                  "description" : "The rate of tax used to calculate tax amount\n",
                  "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.\n",
                  "example" : null
                },
                "is_non_compliance_tax" : {
                  "type" : "boolean",
                  "deprecated" : false,
                  "description" : "Indicates the non-compliance tax that should not be reported to the jurisdiction.\n",
                  "example" : null
                },
                "taxable_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Indicates the actual portion of the line item amount that is taxable.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "tax_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "The tax amount\n",
                  "minimum" : 0,
                  "example" : null
                },
                "tax_juris_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The type of tax jurisdiction\n\n* unincorporated - Combined tax of state and county.\n* federal - The tax jurisdiction is a federal\n* state - The tax jurisdiction is a state\n* county - The tax jurisdiction is a county\n* country - The tax jurisdiction is a country\n* city - The tax jurisdiction is a city\n* other - Jurisdictions other than the ones listed above.\n* special - Special tax jurisdiction.\n",
                  "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\n",
                  "maxLength" : 250,
                  "example" : null
                },
                "tax_juris_code" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The tax jurisdiction code\n",
                  "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.\n",
                  "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.\n",
                  "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.\n",
            "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)\n.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "description" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Description for this deduction.\n",
                  "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]`\nis `item_level_coupon`\nor `document_level_coupon`\n.\n",
                  "maxLength" : 40,
                  "example" : null
                },
                "entity_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The type of deduction and the amount to which it is applied.\n\n* document_level_coupon -\n  The deduction is due to a coupon applied to the invoice `sub_total`.\n  The coupon id is passed as `entity_id`\n  .\n* prorated_credits -\n  The deduction is due to a legacy adjustment credit applied to the invoice. The `entity_id`\n  is `null`\n  in this case. The legacy credits feature is superseded by [adjustment_credit_notes](/docs/api/invoices/invoice-object#adjustment_credit_notes)\n  .\n* item_level_coupon -\n  The deduction is due to a coupon applied to line item. The coupon `id`\n  is passed as `entity_id`\n  .\n* item_level_discount -\n  The deduction is due to a [discount](/docs/api/discounts)\n  applied to a line item of the invoice. The discount `id`\n  is available as the `entity_id`.\n* promotional_credits -\n  The deduction is due to a [promotional credit](/docs/api/promotional_credits)\n  applied to the invoice.\n* document_level_discount -\n  The deduction is due to a [discount](/docs/api/discounts)\n  applied to the invoice `sub_total`.\n  The discount `id`\n  is available as the `entity_id`.\n",
                  "enum" : [ "item_level_coupon", "document_level_coupon", "promotional_credits", "prorated_credits" ],
                  "example" : null
                },
                "discount_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "enum" : [ "fixed_amount", "percentage" ],
                  "example" : null
                },
                "entity_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "When the deduction is due to a\n`coupon`\n, then this is the\n`id`\nof the coupon.\n",
                  "maxLength" : 100,
                  "example" : null
                },
                "coupon_set_code" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The [coupon code](/docs/api/coupon_codes/coupon_code-object#code)\n, if applicable, used to provide the discount. The [coupon.id](/docs/api/coupons/coupon-object#id)\nis available in `entity_id`\n.\n",
                  "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.\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "name" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The name of the tax applied. E.g. GST.\n",
                  "maxLength" : 100,
                  "example" : null
                },
                "amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "The tax amount.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "description" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Description of the tax item.\n",
                  "maxLength" : 250,
                  "example" : null
                }
              },
              "required" : [ "amount", "name" ],
              "example" : null
            },
            "example" : null
          }
        },
        "required" : [ "sub_total" ],
        "example" : null
      },
      "QuoteUpdatedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "quote" : {
                "$ref" : "#/components/schemas/Quote"
              }
            },
            "required" : [ "quote" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "QuotedCharge" : {
        "type" : "object",
        "description" : "When the\n[operation_type](/docs/api/quotes/quote-object#operation_type)\nof a\n`quote`\nis\n`onetime_invoice`\n, the\n`quoted_charges`\nresource contains the details of the invoice that is eventually created once the quote is invoiced. It is always returned along with the quote.\n",
        "properties" : {
          "charges" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "Provides details of all the ad-hoc charges\n[added to the quote](/docs/api/v2/pcv-1/quotes/create-quote-for-one-time-charges)\n.\n",
            "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)\n.\n",
                  "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).\nApplicable only when multi-decimal pricing is enabled.\n",
                  "maxLength" : 39,
                  "example" : null
                },
                "description" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Description for this charge\n",
                  "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)\nis set to current date/time and `invoice.line_item.date_to`\nis set to `service_period_in_days`\nahead of `date_from`\n.\n",
                  "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)\nintegration.\n\n* wholesale - Transaction is a sale to another company that will resell your product or service to another consumer\n* consumed - Transaction is for an item that is consumed directly\n* vendor_use - Transaction is for an item that is subject to vendor use tax\n* retail - Transaction is a sale to an end user\n",
                  "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)\nintegration.\n",
                  "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)\nintegration.\n",
                  "example" : null
                }
              },
              "example" : null
            },
            "example" : null
          },
          "addons" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "Provides details of the addons that are part of the quote.\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Identifier of the addon. Multiple addons can be passed.\n",
                  "maxLength" : 100,
                  "example" : null
                },
                "quantity" : {
                  "type" : "integer",
                  "format" : "int32",
                  "default" : 1,
                  "deprecated" : false,
                  "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                  "minimum" : 1,
                  "example" : null
                },
                "unit_price" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "The price or per-unit-price of the addon. The value depends on the [type of currency](/docs/api/getting-started).  \n**Note:**\n\nFor recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the [addon period](/docs/api/v2/pcv-1/addons/addon-object#period). For example, consider the following details:\n\n* The `unit_price` provided is $10\n* The addon billing period is 1 month.\n* The plan billing period is 3 months.\n* The addon is only billed for $10 on each subscription renewal.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "quantity_in_decimal" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The decimal representation of the quantity of the addon. Returned for quantity-based plans when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "maxLength" : 33,
                  "example" : null
                },
                "unit_price_in_decimal" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The decimal representation of the price or per-unit price of the addon. The value is in major units of the currency. Always returned when multi-decimal pricing is enabled.  \n**Note:**\n\nFor recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:\n\n* The `unit_price_in_decimal` provided is $10.75\n* The addon billing period is 1 month.\n* The plan billing period is 3 months.\n* The addon is only billed for $10.75 on each subscription renewal.\n",
                  "maxLength" : 39,
                  "example" : null
                },
                "proration_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "enum" : [ "full_term", "partial_term", "none" ],
                  "example" : null
                },
                "service_period" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "description" : "Specifies the service period of the addon in days. When the quote is converted, the [invoice.line_item.date_from](/docs/api/invoices/invoice-object#line_items)\nis set to current date/time and [invoice.line_item.date_to](/docs/api/invoices/invoice-object#line_items)\nis set to `service_period`\ndays ahead of [date_from](/docs/api/invoices/invoice-object#line_items)\n.\n",
                  "example" : null
                }
              },
              "required" : [ "id" ],
              "example" : null
            },
            "example" : null
          },
          "coupons" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "List of coupons for this charge\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "coupon_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Used to uniquely identify the coupon\n",
                  "maxLength" : 100,
                  "example" : null
                }
              },
              "required" : [ "coupon_id" ],
              "example" : null
            },
            "example" : null
          },
          "coupon_applicability_mappings" : {
            "type" : "array",
            "deprecated" : false,
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "coupon_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 50,
                  "example" : null
                },
                "applicable_item_price_ids" : {
                  "type" : "array",
                  "deprecated" : false,
                  "items" : {
                    "type" : "string",
                    "deprecated" : false,
                    "maxLength" : 100,
                    "example" : null
                  },
                  "example" : null
                }
              },
              "example" : null
            },
            "example" : null
          }
        },
        "example" : null
      },
      "QuotedDeltaRamp" : {
        "type" : "object",
        "properties" : {
          "line_items" : {
            "type" : "array",
            "deprecated" : false,
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "item_level_discount_per_billing_cycle_in_decimal" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 39,
                  "example" : null
                }
              },
              "example" : null
            },
            "example" : null
          }
        },
        "example" : null
      },
      "QuotedRamp" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 50,
            "example" : null
          },
          "line_items" : {
            "type" : "array",
            "deprecated" : false,
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "item_price_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 100,
                  "example" : null
                },
                "item_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "enum" : [ "plan", "addon", "charge" ],
                  "example" : null
                },
                "quantity" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "minimum" : 1,
                  "example" : null
                },
                "quantity_in_decimal" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 33,
                  "example" : null
                },
                "unit_price" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "minimum" : 0,
                  "example" : null
                },
                "unit_price_in_decimal" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 39,
                  "example" : null
                },
                "amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "minimum" : 0,
                  "example" : null
                },
                "amount_in_decimal" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 39,
                  "example" : null
                },
                "billing_period" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "minimum" : 1,
                  "example" : null
                },
                "billing_period_unit" : {
                  "type" : "string",
                  "deprecated" : false,
                  "enum" : [ "day", "week", "month", "year" ],
                  "example" : null
                },
                "free_quantity" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "minimum" : 0,
                  "example" : null
                },
                "free_quantity_in_decimal" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 33,
                  "example" : null
                },
                "billing_cycles" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "minimum" : 0,
                  "example" : null
                },
                "service_period_days" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "maximum" : 730,
                  "minimum" : 1,
                  "example" : null
                },
                "charge_on_event" : {
                  "type" : "string",
                  "deprecated" : false,
                  "enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ],
                  "example" : null
                },
                "charge_once" : {
                  "type" : "boolean",
                  "deprecated" : false,
                  "example" : null
                },
                "charge_on_option" : {
                  "type" : "string",
                  "deprecated" : false,
                  "enum" : [ "immediately", "on_event" ],
                  "example" : null
                },
                "start_date" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "example" : null
                },
                "end_date" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "example" : null
                },
                "ramp_tier_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 105,
                  "example" : null
                },
                "discount_per_billing_cycle" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "minimum" : 0,
                  "example" : null
                },
                "discount_per_billing_cycle_in_decimal" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 39,
                  "example" : null
                },
                "item_level_discount_per_billing_cycle" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "minimum" : 0,
                  "example" : null
                },
                "item_level_discount_per_billing_cycle_in_decimal" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 39,
                  "example" : null
                },
                "amount_per_billing_cycle" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "minimum" : 0,
                  "example" : null
                },
                "amount_per_billing_cycle_in_decimal" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 39,
                  "example" : null
                },
                "net_amount_per_billing_cycle" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "minimum" : 0,
                  "example" : null
                },
                "net_amount_per_billing_cycle_in_decimal" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 39,
                  "example" : null
                },
                "description" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 2000,
                  "example" : null
                }
              },
              "required" : [ "item_price_id", "item_type" ],
              "example" : null
            },
            "example" : null
          },
          "discounts" : {
            "type" : "array",
            "deprecated" : false,
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 50,
                  "example" : null
                },
                "invoice_name" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 100,
                  "example" : null
                },
                "type" : {
                  "type" : "string",
                  "default" : "percentage",
                  "deprecated" : false,
                  "enum" : [ "fixed_amount", "percentage" ],
                  "example" : null
                },
                "percentage" : {
                  "type" : "number",
                  "format" : "double",
                  "deprecated" : false,
                  "maximum" : 100,
                  "minimum" : 0.01,
                  "example" : null
                },
                "amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "minimum" : 0,
                  "example" : null
                },
                "duration_type" : {
                  "type" : "string",
                  "default" : "forever",
                  "deprecated" : false,
                  "enum" : [ "one_time", "forever", "limited_period" ],
                  "example" : null
                },
                "entity_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "enum" : [ "item_level_coupon", "document_level_coupon" ],
                  "example" : null
                },
                "entity_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 100,
                  "example" : null
                },
                "period" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "minimum" : 1,
                  "example" : null
                },
                "period_unit" : {
                  "type" : "string",
                  "deprecated" : false,
                  "enum" : [ "day", "week", "month", "year" ],
                  "example" : null
                },
                "included_in_mrr" : {
                  "type" : "boolean",
                  "deprecated" : false,
                  "example" : null
                },
                "apply_on" : {
                  "type" : "string",
                  "deprecated" : false,
                  "enum" : [ "invoice_amount", "specific_item_price" ],
                  "example" : null
                },
                "item_price_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 100,
                  "example" : null
                },
                "created_at" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "example" : null
                },
                "updated_at" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "example" : null
                },
                "start_date" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "example" : null
                },
                "end_date" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "example" : null
                }
              },
              "required" : [ "apply_on", "created_at", "duration_type", "entity_type", "id", "included_in_mrr", "type" ],
              "example" : null
            },
            "example" : null
          },
          "item_tiers" : {
            "type" : "array",
            "deprecated" : false,
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "item_price_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 100,
                  "example" : null
                },
                "starting_unit" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "minimum" : 1,
                  "example" : null
                },
                "ending_unit" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "example" : null
                },
                "price" : {
                  "type" : "integer",
                  "format" : "int64",
                  "default" : 0,
                  "deprecated" : false,
                  "minimum" : 0,
                  "example" : null
                },
                "starting_unit_in_decimal" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 33,
                  "example" : null
                },
                "ending_unit_in_decimal" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 33,
                  "example" : null
                },
                "price_in_decimal" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 39,
                  "example" : null
                },
                "ramp_tier_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 105,
                  "example" : null
                },
                "pricing_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "enum" : [ "per_unit", "flat_fee", "package" ],
                  "example" : null
                },
                "package_size" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "minimum" : 1,
                  "example" : null
                }
              },
              "required" : [ "item_price_id", "price", "starting_unit" ],
              "example" : null
            },
            "example" : null
          },
          "coupon_applicability_mappings" : {
            "type" : "array",
            "deprecated" : false,
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "coupon_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "maxLength" : 50,
                  "example" : null
                },
                "applicable_item_price_ids" : {
                  "type" : "array",
                  "deprecated" : false,
                  "items" : {
                    "type" : "string",
                    "deprecated" : false,
                    "maxLength" : 100,
                    "example" : null
                  },
                  "example" : null
                }
              },
              "example" : null
            },
            "example" : null
          }
        },
        "required" : [ "id" ],
        "example" : null
      },
      "QuotedSubscription" : {
        "type" : "object",
        "description" : "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.\n",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "A unique and immutable identifier for the subscription. If not provided, it is autogenerated.\n",
            "maxLength" : 50,
            "example" : null
          },
          "plan_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Identifier of the plan for this subscription\n",
            "maxLength" : 100,
            "example" : null
          },
          "plan_quantity" : {
            "type" : "integer",
            "format" : "int32",
            "default" : 1,
            "deprecated" : false,
            "description" : "Represents the plan quantity for this subscription.\n",
            "minimum" : 1,
            "example" : null
          },
          "plan_unit_price" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Amount that will override the Plan's default price. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
            "minimum" : 0,
            "example" : null
          },
          "setup_fee" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Amount that will override the default setup fee. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
            "minimum" : 0,
            "example" : null
          },
          "billing_period" : {
            "type" : "integer",
            "format" : "int32",
            "deprecated" : false,
            "description" : "Defines billing frequency. Example: to bill customer every 3 months, provide \"3\" here.\n",
            "minimum" : 1,
            "example" : null
          },
          "billing_period_unit" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Defines billing frequency in association with the billing period.\n\n* week - Charge based on week(s)\n* day - Charge based on day(s)\n* month - Charge based on month(s)\n* year - Charge based on year(s)\n",
            "enum" : [ "day", "week", "month", "year" ],
            "example" : null
          },
          "start_date" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Applicable only when `operation_type`\nof the quote is `create_subscription_for_customer`.\nFor subscriptions in the `future`\n`status`\n, 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:\n\n* Backdating is enabled for subscription creation operations.\n* 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.\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 subscription's plan is 2 months and today is 14th April, the `start_date` cannot be earlier than 14th February.\n",
            "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.\n",
            "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.\n* 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.\n",
            "minimum" : 0,
            "example" : null
          },
          "po_number" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Purchase order number for this subscription.\n",
            "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.\n\n* on - Whenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.\n* off - Automatic collection of charges will not be made for this subscription. Use this for offline payments.\n",
            "enum" : [ "on", "off" ],
            "example" : null
          },
          "plan_quantity_in_decimal" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The decimal representation of the quantity of the plan purchased. Returned for quantity-based plans when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
            "maxLength" : 33,
            "example" : null
          },
          "plan_unit_price_in_decimal" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The decimal representation of the price or per-unit price of the plan. The value is in major units of the currency. Always returned when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
            "maxLength" : 39,
            "example" : null
          },
          "changes_scheduled_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Applicable only when `operation_type`\nof the quote is `change_subscription`.\nWhen `change_option`\nis set to `specific_date`\n, 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:\n\n* Backdating must be enabled for subscription change operations.\n\n* Only the following changes can be backdated:\n\n* Changes in the recurring items or their prices.\n\n* Addition of non-recurring items.\n\n* Subscription `status` is `active`, `cancelled`, or `non_renewing`.\n\n* 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.\n\n* The date is on or after `current_term_start`.\n\n* The date is on or after the last date/time any of the following changes were made:\n\n* Changes in the recurring items or their prices.\n\n* Addition of non-recurring items.\n\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 subscription's plan is 2 months and today is 14th April, `changes_scheduled_at` cannot be earlier than 14th February.\n\n",
            "example" : null
          },
          "change_option" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Applicable only when `operation_type`\nof the quote is `change_subscription`.\nWhen the quote is converted, this attribute determines the date/time as of when the subscription change is to be carried out.\n\n* end_of_term - The change is scheduled to be carried out at the end of the billing cycle of the subscription.\n* specific_date -\n  The change is carried out as of `changes_scheduled_at`\n  .\n* immediately - The change is carried out immediately upon quote conversion.\n",
            "enum" : [ "end_of_term", "specific_date", "immediately" ],
            "example" : null
          },
          "free_period" : {
            "type" : "integer",
            "format" : "int32",
            "deprecated" : false,
            "minimum" : 1,
            "example" : null
          },
          "free_period_unit" : {
            "type" : "string",
            "deprecated" : false,
            "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`\nor a custom value depending on the [site configuration](https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms)\n.\n",
            "maximum" : 100,
            "minimum" : 1,
            "example" : null
          },
          "addons" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "List of addons for this subscription with quantity(if applicable)\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Identifier of the addon. Multiple addons can be passed.\n",
                  "maxLength" : 100,
                  "example" : null
                },
                "quantity" : {
                  "type" : "integer",
                  "format" : "int32",
                  "default" : 1,
                  "deprecated" : false,
                  "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                  "minimum" : 1,
                  "example" : null
                },
                "unit_price" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "The price or per-unit-price of the addon. The value depends on the [type of currency](/docs/api/getting-started).  \n**Note:**\n\nFor recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the [addon period](/docs/api/v2/pcv-1/addons/addon-object#period). For example, consider the following details:\n\n* The `unit_price` provided is $10\n* The addon billing period is 1 month.\n* The plan billing period is 3 months.\n* The addon is only billed for $10 on each subscription renewal.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "The total amount for the addon. The format of the value [depends upon the currency](/docs/api/currencies)\n.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "trial_end" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "The time at which the trial ends for the addon. This value can only be set for subscriptions that start with an `active`\nor `non-renewing`\nstatus. Once set, the value can't be changed. (Addon trial periods must be enabled by [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",
                  "example" : null
                },
                "remaining_billing_cycles" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "description" : "The number of billing cycles this addon will be attached to subscription.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "quantity_in_decimal" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The decimal representation of the quantity of the addon. Returned for quantity-based plans when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "maxLength" : 33,
                  "example" : null
                },
                "unit_price_in_decimal" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The decimal representation of the price or per-unit price of the addon. The value is in major units of the currency. Always returned when multi-decimal pricing is enabled.  \n**Note:**\n\nFor recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:\n\n* The `unit_price_in_decimal` provided is $10.75\n* The addon billing period is 1 month.\n* The plan billing period is 3 months.\n* The addon is only billed for $10.75 on each subscription renewal.\n",
                  "maxLength" : 39,
                  "example" : null
                },
                "amount_in_decimal" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The decimal representation of the total amount for the addon, in major units of the currency. Always returned when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "maxLength" : 39,
                  "example" : null
                },
                "proration_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "enum" : [ "full_term", "partial_term", "none" ],
                  "example" : null
                }
              },
              "required" : [ "id" ],
              "example" : null
            },
            "example" : null
          },
          "event_based_addons" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "List of non-recurring addons that will be charged on the occurrence of specified event.\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "A unique 'id' used to identify the addon.\n",
                  "maxLength" : 100,
                  "example" : null
                },
                "quantity" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                  "minimum" : 1,
                  "example" : null
                },
                "unit_price" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "on_event" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Event on which this addon will be charged.\n\n* plan_activation - Addon will be charged on plan activation.\n* subscription_activation - Addon will be charged on subscription activation.\n* subscription_creation - Addon will be charged on subscription creation.\n* subscription_trial_start - Addon will be charged when the trial period starts.\n* contract_termination - Addon will be charged on contract termination.\n",
                  "enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ],
                  "example" : null
                },
                "charge_once" : {
                  "type" : "boolean",
                  "default" : true,
                  "deprecated" : false,
                  "description" : "If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.\n",
                  "example" : null
                },
                "quantity_in_decimal" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The decimal representation of the quantity of the addon. Returned for quantity-based addons when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "maxLength" : 33,
                  "example" : null
                },
                "unit_price_in_decimal" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The decimal representation of the price or per-unit price of the addon. The value is in major units of the currency. Always returned when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "maxLength" : 39,
                  "example" : null
                }
              },
              "required" : [ "charge_once", "id", "on_event", "quantity", "unit_price" ],
              "example" : null
            },
            "example" : null
          },
          "coupons" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "List of coupons for this subscription\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "coupon_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Used to uniquely identify the coupon\n",
                  "maxLength" : 100,
                  "example" : null
                }
              },
              "required" : [ "coupon_id" ],
              "example" : null
            },
            "example" : null
          },
          "quoted_contract_term" : {
            "type" : "object",
            "deprecated" : false,
            "description" : "The details of the contract term to be created when this quote is invoiced.\n",
            "properties" : {
              "contract_start" : {
                "type" : "integer",
                "format" : "unix-time",
                "deprecated" : false,
                "description" : "The start date of the contract term\n",
                "example" : null
              },
              "contract_end" : {
                "type" : "integer",
                "format" : "unix-time",
                "deprecated" : false,
                "description" : "The end date of the contract term\n",
                "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.\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.\n\n* renew -\n  * 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).\n  * The `action_at_term_end` for the new contract term is set to `renew`.\n* renew_once -\n  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).\n\n  * The `action_at_term_end` for the new contract term is set to `cancel`.\n* cancel - Contract term completes and subscription is canceled.\n* evergreen - Contract term completes and the subscription renews.\n",
                "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)\nof all the invoices raised as part of the contract term. For `active`\ncontract terms, this is a predicted value. The value depends on the [type of currency](/docs/api/v2/pcv-1/quoted_subscriptions).\nIf the subscription was [imported](/docs/api/v2/pcv-1/quoted_subscriptions)\nwith the contract term, then this value includes the value passed for `total_amount_raised`\n.\n",
                "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)\n, 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.\n",
                "example" : null
              }
            },
            "required" : [ "action_at_term_end", "billing_cycle", "contract_end", "contract_start", "total_contract_value" ],
            "example" : null
          }
        },
        "required" : [ "id", "plan_id", "plan_quantity" ],
        "example" : null
      },
      "ReasonCode" : {
        "type" : "object",
        "properties" : {
          "type" : {
            "type" : "string",
            "deprecated" : false,
            "enum" : [ "subscription_cancellation", "create_credit_note", "refund_credit_note", "void_invoice", "order_resend" ],
            "example" : null
          },
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 50,
            "example" : null
          },
          "code" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 100,
            "example" : null
          },
          "status" : {
            "type" : "string",
            "deprecated" : false,
            "enum" : [ "enabled", "disabled" ],
            "example" : null
          }
        },
        "required" : [ "code", "id", "status", "type" ],
        "example" : null
      },
      "ReferenceCount" : {
        "type" : "object",
        "description" : "This resource returns the number of items.\n",
        "properties" : {
          "type" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The `type`\nof the `item`\n\n* charge - Charge\n* plan - Plan\n* addon - Addon\n",
            "enum" : [ "plan", "addon", "charge", "plan_price", "addon_price" ],
            "example" : null
          },
          "count" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Number of items.\n",
            "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.\n",
        "properties" : {
          "from_site" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Domain name to which the item is moved.\n",
            "maxLength" : 50,
            "minLength" : 4,
            "example" : null
          },
          "entity_type" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Type of the entity this record is stored for\n\n* customer - Entity that represents a customer\n",
            "enum" : [ "customer" ],
            "example" : null
          },
          "entity_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Handle of the customer in the current site.\n",
            "maxLength" : 100,
            "example" : null
          },
          "status" : {
            "type" : "string",
            "default" : "failed",
            "deprecated" : false,
            "description" : "Status of the copy customer process.\n\n* failed - Failed\n* succeeded - Succeeded\n* scheduled - Scheduled\n",
            "enum" : [ "scheduled", "failed", "succeeded" ],
            "example" : null
          },
          "errors" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Filled only if the copy operation gets failed\n",
            "maxLength" : 65000,
            "example" : null
          },
          "created_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Time the log is created\n",
            "example" : null
          },
          "updated_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Time the log is updated\n",
            "example" : null
          }
        },
        "required" : [ "created_at", "entity_id", "entity_type", "from_site", "status", "updated_at" ],
        "example" : null
      },
      "ResponseDocumentType" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "application_response" ],
        "example" : null
      },
      "ResponseStatus" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "accepted", "rejected", "message_acknowledgement", "in_process", "under_query", "conditionally_accepted", "paid" ],
        "example" : null
      },
      "ResumeOption" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "immediately", "specific_date" ],
        "example" : null
      },
      "RetryEngine" : {
        "type" : "string",
        "default" : "chargebee",
        "deprecated" : false,
        "enum" : [ "chargebee", "flexpay", "successplus" ],
        "example" : null
      },
      "Role" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "primary", "backup", "none" ],
        "example" : null
      },
      "Rule" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 50,
            "example" : null
          },
          "namespace" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 100,
            "example" : null
          },
          "rule_name" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 100,
            "example" : null
          },
          "rule_order" : {
            "type" : "integer",
            "format" : "int32",
            "deprecated" : false,
            "example" : null
          },
          "status" : {
            "type" : "string",
            "deprecated" : false,
            "enum" : [ "active", "disabled" ],
            "example" : null
          },
          "conditions" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 65000,
            "example" : null
          },
          "outcome" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 65000,
            "example" : null
          },
          "deleted" : {
            "type" : "boolean",
            "default" : false,
            "deprecated" : false,
            "example" : null
          },
          "created_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "example" : null
          },
          "modified_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "example" : null
          }
        },
        "required" : [ "created_at", "deleted", "id", "modified_at", "namespace", "rule_name", "status" ],
        "example" : null
      },
      "RuleCreatedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "rule" : {
                "$ref" : "#/components/schemas/Rule"
              }
            },
            "required" : [ "rule" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "RuleDeletedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "rule" : {
                "$ref" : "#/components/schemas/Rule"
              }
            },
            "required" : [ "rule" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "RuleUpdatedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "rule" : {
                "$ref" : "#/components/schemas/Rule"
              }
            },
            "required" : [ "rule" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "ScheduleType" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "immediate", "specific_dates", "fixed_intervals" ],
        "example" : null
      },
      "SettingsPreferenceDefinition" : {
        "type" : "object",
        "properties" : { },
        "example" : null
      },
      "Site" : {
        "type" : "object",
        "description" : "Represents a platform site in Chargebee.\nEach platform site includes a unique `id`, the associated `site_id`, and a `domain`, along with its `site_type` and `created_at` timestamp.\n",
        "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.\n",
            "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.\n",
            "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.\n",
            "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.\n",
        "properties" : {
          "entity_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Id of the entity in this site.\n",
            "maxLength" : 100,
            "example" : null
          },
          "other_site_name" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Site name to which the record is moved in/out.\n",
            "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.\n",
            "maxLength" : 100,
            "example" : null
          },
          "migrated_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Date in which the record is copied\n",
            "example" : null
          },
          "entity_type" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Entity Type of the record\n\n* order - Entity that represents an order\n* customer - Entity that represents a customer\n* invoice - Invoice description\n* subscription - Entity that represents a subscription of a customer\n* transaction - Entity that represents a transaction.\n* credit_note - Credit note description\n",
            "enum" : [ "customer", "subscription", "invoice", "credit_note", "transaction", "order" ],
            "example" : null
          },
          "status" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Status of the migration\n\n* moving_out - Moving out from one cb site to another\n* moved_in - Moved in from another cb site\n* moved_out - Moved out from one cb site to another\n",
            "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.\nEach site owner includes a unique `id` and required `email`, and can optionally include `name`, `customer_id`, and `updated_at`.\n",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Unique identifier of the site owner. Maximum length is 40 characters. This field is required.\n",
            "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.\n",
            "maxLength" : 70,
            "example" : null
          },
          "name" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Name of the site owner. Maximum length is 50 characters.\n",
            "maxLength" : 50,
            "example" : null
          },
          "customer_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "ID of the associated customer. Maximum length is 50 characters.\n",
            "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.\n",
            "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" : "Subscription represents the recurring items a customer has subscribed to. The recurring items can be - plan, addons. It may also contain the discount items like coupons.\n\nSubscriptions 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'.  \n**Note:**\nThe maximum number of subscriptions for any given [customer](/docs/api/customers)\n([active](/docs/api/subscriptions/subscription-object#status)\nor not) is 900.  \nTax provider fields  \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`\nbelong 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 [Plan](/docs/api/v2/pcv-1/plans/plan-object)(PC1), [Addons](/docs/api/v2/pcv-1/addons/addon-object)(PC1) and [Item Prices](/docs/api/item_prices/item-price-object)(PC2) attributes.                                                                                                                                                               |\n| `productClass`  | Merchant to configure it on Vertex Platform | APIs having [Plan](/docs/api/v2/pcv-1/plans/plan-object)(PC1), [Addons](/docs/api/v2/pcv-1/addons/addon-object)(PC1) and [Item Prices](/docs/api/item_prices/item-price-object)(PC2) 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 [Plan](/docs/api/v2/pcv-1/plans/plan-object)(PC1), [Addons](/docs/api/v2/pcv-1/addons/addon-object)(PC1) and Item Prices (PC2) attributes.                                                                                                                                                                                                         |\n| `productClass`   | Merchant to configure it on Taxamo Platform | APIs having [Plan](/docs/api/v2/pcv-1/plans/plan-object)(PC1), [Addons](/docs/api/v2/pcv-1/addons/addon-object)(PC1) and Item Prices (PC2) 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`  | Removes price type override, and allows site level configuration to be used for tax calculation.                                                                                                                                                                                                                                                               |\n\n**Note:**\nMake sure you choose the correct **Field ID**\nand **Available APIs**\ncombination from the table above.\nAll Product Catalog APIs include [Plans](/docs/api/v2/pcv-1/plans)\n, [Addons](/docs/api/v2/pcv-1/addons)\n, [Coupons](/docs/api/v2/pcv-1/coupons)\n, [Coupon Sets](/docs/api/v2/pcv-1/coupon_sets)\n, [Coupon Codes](/docs/api/v2/pcv-1/coupon_codes)\n.\n",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "A unique and immutable identifier for the subscription. If not provided, it is autogenerated.\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)\n) of the subscription\n",
            "maxLength" : 3,
            "example" : null
          },
          "plan_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Identifier of the plan for this subscription\n",
            "maxLength" : 100,
            "example" : null
          },
          "plan_quantity" : {
            "type" : "integer",
            "format" : "int32",
            "default" : 1,
            "deprecated" : false,
            "description" : "Represents the plan quantity for this subscription.\n",
            "minimum" : 1,
            "example" : null
          },
          "plan_unit_price" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Amount that will override the Plan's default price. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
            "minimum" : 0,
            "example" : null
          },
          "setup_fee" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Amount that will override the default setup fee. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
            "minimum" : 0,
            "example" : null
          },
          "billing_period" : {
            "type" : "integer",
            "format" : "int32",
            "deprecated" : false,
            "description" : "Defines billing frequency. Example: to bill customer every 3 months, provide \"3\" here.\n",
            "minimum" : 1,
            "example" : null
          },
          "billing_period_unit" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Defines billing frequency in association with the billing period.\n\n* day - Charge based on day(s)\n* month - Charge based on month(s)\n* year - Charge based on year(s)\n* week - Charge based on week(s)\n",
            "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.\n",
            "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.\n",
            "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.\n* 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.\n",
            "minimum" : 0,
            "example" : null
          },
          "po_number" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Purchase order number for this subscription.\n",
            "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.\n\n* on - Whenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.\n* off - Automatic collection of charges will not be made for this subscription. Use this for offline payments.\n",
            "enum" : [ "on", "off" ],
            "example" : null
          },
          "plan_quantity_in_decimal" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The decimal representation of the quantity of the plan purchased. Returned for quantity-based plans when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
            "maxLength" : 33,
            "example" : null
          },
          "plan_unit_price_in_decimal" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The decimal representation of the price or per-unit price of the plan. The value is in major units of the currency. Always returned when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
            "maxLength" : 39,
            "example" : null
          },
          "customer_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Identifier of the customer with whom this subscription is associated.\n",
            "maxLength" : 50,
            "example" : null
          },
          "plan_amount" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "The total amount for the plan.\n",
            "minimum" : 0,
            "example" : null
          },
          "plan_free_quantity" : {
            "type" : "integer",
            "format" : "int32",
            "deprecated" : false,
            "description" : "The units of the item that will be free with this Plan.\n",
            "minimum" : 0,
            "example" : null
          },
          "status" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Current state of the subscription\n\n* future - The subscription is scheduled to start at a future date.\n* non_renewing - The subscription will be canceled at the end of the current term.\n* active - The subscription is active and will be charged for automatically based on the items in it.\n* cancelled - The subscription has been canceled and is no longer in service.\n* transferred -\n  The `transferred`\n  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)\n  activity is completed successfully. This status is only valid for [product catalog 2.0](https://www.chargebee.com/docs/2.0/product-catalog.html)\n  as the Multiple Business Entity features can only be enabled for product catalog 2.0.\n* in_trial - The subscription is in trial.\n* paused -\n  The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html).\n  The subscription will not renew while in this state.\n",
            "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`\nsubscription implies the subscription will go into `in_trial`\nstate when it starts.\n",
            "example" : null
          },
          "trial_end_action" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Applicable only when [End-of-trial Action](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)\nhas 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.\n\n* activate_subscription - The subscription activates and charges are raised for non-metered items.\n* cancel_subscription - The subscription cancels.\n* plan_default -\n  The action [configured for the site](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)\n  at the time when the trial ends, takes effect.\n* site_default -\n  This is the default value. The action [configured for the site](https://www.chargebee.com/docs/1.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions)\n  at the time when the trial ends, takes effect.\n",
            "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.\n",
            "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\n",
            "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`\nunless multiple subscription terms were invoiced in advance using the `terms_to_charge`\nparameter.\n",
            "example" : null
          },
          "created_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "The time at which the subscription was created.\n",
            "example" : null
          },
          "started_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Time at which the subscription was started. Is `null`\nfor `future`\nsubscriptions as it is yet to be started.\n",
            "example" : null
          },
          "activated_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Time at which the subscription `status`\nlast changed to\n`active`.\nFor example, this value is updated when an `in_trial`\nor\n`cancelled`\nsubscription activates.\n",
            "example" : null
          },
          "gift_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "References the gift if it is a gifted subscription.\n",
            "maxLength" : 150,
            "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`\nor a custom value depending on the [site configuration](https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms)\n.\n",
            "maximum" : 100,
            "minimum" : 1,
            "example" : null
          },
          "override_relationship" : {
            "type" : "boolean",
            "deprecated" : false,
            "description" : "If `true`\n, ignores the [hierarchy relationship](/docs/api/customers/customer-object#relationship)\nand uses customer as payment and invoice owner.\n",
            "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`\nstate, it is the date/time when the subscription was paused.\n",
            "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.\n",
            "example" : null
          },
          "cancelled_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Time at which subscription was cancelled or is set to be cancelled.\n",
            "example" : null
          },
          "cancel_reason" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The reason for canceling the subscription. Set by Chargebee automatically.\n\n* no_card - No Card\n* non_compliant_customer - Non Compliant Customer\n* currency_incompatible_with_gateway - Currency incompatible with Gateway\n* fraud_review_failed - Fraud Review Failed\n* tax_calculation_failed - Tax Calculation Failed\n* not_paid - Not Paid\n* non_compliant_eu_customer - Non Compliant EU Customer\n",
            "enum" : [ "not_paid", "no_card", "fraud_review_failed", "non_compliant_eu_customer", "tax_calculation_failed", "currency_incompatible_with_gateway", "non_compliant_customer" ],
            "example" : null
          },
          "affiliate_token" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "A unique tracking token\n",
            "maxLength" : 250,
            "example" : null
          },
          "created_from_ip" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The IP address of the user. Used primarly in Refersion integration. Refersion uses this field to track/log affiliate subscription.\n",
            "maxLength" : 50,
            "example" : null
          },
          "resource_version" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Version number of this resource. The `resource_version`\nis 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.\n",
            "example" : null
          },
          "updated_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp indicating when the item was last updated.\n",
            "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)\n.\n",
            "example" : null
          },
          "has_scheduled_changes" : {
            "type" : "boolean",
            "default" : false,
            "deprecated" : false,
            "description" : "If `true`\n, there are subscription changes scheduled on next renewal.\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.\n",
            "maxLength" : 40,
            "example" : null
          },
          "plan_free_quantity_in_decimal" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The free_quantity_in_decimal as set for the plan. Returned for quantity-based plans when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
            "maxLength" : 33,
            "example" : null
          },
          "plan_amount_in_decimal" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The decimal representation of the total amount for the plan, in major units of the currency. Always returned when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
            "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`\nsubscriptions or subscriptions that are scheduled for cancellation.\n",
            "example" : null
          },
          "offline_payment_method" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The preferred offline payment method for the subscription.\n\n* sepa_credit - SEPA Credit\n* cash - Cash\n* no_preference - No Preference\n* bank_transfer - Bank Transfer\n* check - Check\n* eu_automated_bank_transfer - EU Automated Bank Transfer\n* jp_automated_bank_transfer - JP Automated Bank Transfer\n* uk_automated_bank_transfer - UK Automated Bank Transfer\n* custom - Custom\n* boleto - Boleto\n* mx_automated_bank_transfer - MX Automated Bank Transfer\n* us_automated_bank_transfer - US Automated Bank Transfer\n* ach_credit - ACH Credit\n",
            "enum" : [ "no_preference", "cash", "check", "bank_transfer", "ach_credit", "sepa_credit", "boleto", "us_automated_bank_transfer", "eu_automated_bank_transfer", "uk_automated_bank_transfer", "jp_automated_bank_transfer", "mx_automated_bank_transfer", "custom" ],
            "example" : null
          },
          "channel" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The subscription channel this object originated from and is maintained in.\n\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" : "This attribute is only valid for [product catalog 2.0](https://www.chargebee.com/docs/2.0/product-catalog.html)\nas the Multiple Business Entity features can only be enabled for product catalog 2.0.\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.\n**Note:**\nNot supported if [consolidated invoicing](https://www.chargebee.com/docs/consolidated-invoicing.html)\nis enabled, or when the subscription is for the customer who is in [hierarchy](/docs/api/hierarchies)\n, 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`\n.\n",
            "example" : null
          },
          "due_since" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Time since this subscription has unpaid invoices.\n**Note:**\nNot supported if [consolidated invoicing](https://www.chargebee.com/docs/consolidated-invoicing.html)\nis enabled, or when the subscription is for the customer who is in [hierarchy](/docs/api/hierarchies)\n, and the parent of this customer owns and pays for the invoices of the subscription.\n",
            "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/v2/pcv-1/subscriptions)\n.\n**Note:**\nNot supported if [consolidated invoicing](https://www.chargebee.com/docs/consolidated-invoicing.html)\nis enabled, or when the subscription is for the customer who is in [hierarchy](/docs/api/hierarchies)\n, 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`\n.\n",
            "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)\n.\n**Note:**\nThis may not return accurate values since updated asynchronously.\n",
            "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)\non your site each time any change is made to the subscription.\n",
            "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)\n) of the site's base currency.\n",
            "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)\ndisplayed on the invoice PDF.\n",
            "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/v2/pcv-1/advanced-features)\n.\n",
            "example" : null
          },
          "deleted" : {
            "type" : "boolean",
            "deprecated" : false,
            "description" : "Indicates that the subscription has been deleted when the value is `true`.\nYou can retrieve a deleted subscription using the [list operation](/docs/api/subscriptions/list-subscriptions)\n.\n",
            "example" : null
          },
          "changes_scheduled_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "If a subscription change has been scheduled, this is the date/time when the change is set to take effect. **Note:**\nAs a limitation, this 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**.\nMust be passed if set as mandatory in the app. The codes are case-sensitive\n",
            "maxLength" : 100,
            "example" : null
          },
          "free_period" : {
            "type" : "integer",
            "format" : "int32",
            "deprecated" : false,
            "description" : "The period of time by which the first term of the subscription is to be extended free-of-charge. The value must be in multiples of free_period_unit.\"\n",
            "example" : null
          },
          "free_period_unit" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Defines additional free period in association with the billing period.\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" : "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.\nYou 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:\n\n* 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.\n* 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\n",
            "example" : null
          },
          "auto_close_invoices" : {
            "type" : "boolean",
            "deprecated" : false,
            "description" : "Set to `false`\nto override for this subscription, the [site-level setting](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing)\nfor 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)\n.\n",
            "example" : null
          },
          "business_entity_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity.  \n**Note**\n\n[Multiple Business Entities](/docs/api/getting-started) is a feature available only on Product Catalog 2.0.\n",
            "maxLength" : 50,
            "example" : null
          },
          "decommissioned" : {
            "type" : "boolean",
            "default" : false,
            "deprecated" : false,
            "description" : "Specifies whether a cancelled subscription is decommissioned or not\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.\n",
            "maxLength" : 50,
            "example" : null
          },
          "addons" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "List of addons for this subscription with quantity(if applicable)\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Identifier of the addon. Multiple addons can be passed.\n",
                  "maxLength" : 100,
                  "example" : null
                },
                "quantity" : {
                  "type" : "integer",
                  "format" : "int32",
                  "default" : 1,
                  "deprecated" : false,
                  "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                  "minimum" : 1,
                  "example" : null
                },
                "unit_price" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "The price or per-unit-price of the addon. The value depends on the [type of currency](/docs/api/v2/pcv-1/currencies).  \n**Note:**\n\nFor recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the [addon period](/docs/api/v2/pcv-1/addons/addon-object#period). For example, consider the following details:\n\n* The `unit_price` provided is $10\n* The addon billing period is 1 month.\n* The plan billing period is 3 months.\n* The addon is only billed for $10 on each subscription renewal.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "The total amount for the addon. The format of the value [depends upon the currency](/docs/api/currencies)\n.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "trial_end" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "The time at which the trial ends for the addon. This value can only be set for subscriptions that start with an `active`\nor `non-renewing`\nstatus. Once set, the value can't be changed. (Addon trial periods must be enabled by [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",
                  "example" : null
                },
                "remaining_billing_cycles" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "description" : "The number of billing cycles this addon will be attached to subscription.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "quantity_in_decimal" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The decimal representation of the quantity of the addon. Returned for quantity-based plans when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "maxLength" : 33,
                  "example" : null
                },
                "unit_price_in_decimal" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The decimal representation of the price or per-unit price of the addon. The value is in major units of the currency. Always returned when multi-decimal pricing is enabled.  \n**Note:**\n\nFor recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:\n\n* The `unit_price_in_decimal` provided is $10.75\n* The addon billing period is 1 month.\n* The plan billing period is 3 months.\n* The addon is only billed for $10.75 on each subscription renewal.\n",
                  "maxLength" : 39,
                  "example" : null
                },
                "amount_in_decimal" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The decimal representation of the total amount for the addon, in major units of the currency. Always returned when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "maxLength" : 39,
                  "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`addons[proration_type]`\nparameter for [Update a subscription API](/docs/api/v2/pcv-1/subscriptions/update-a-subscription)\n.\n\n* partial_term - Prorate the charges or credits from the time of the change till the end of the current term.\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",
                  "enum" : [ "full_term", "partial_term", "none" ],
                  "example" : null
                }
              },
              "required" : [ "id" ],
              "example" : null
            },
            "example" : null
          },
          "event_based_addons" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "List of non-recurring addons that will be charged on the occurrence of specified event.\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "A unique 'id' used to identify the addon.\n",
                  "maxLength" : 100,
                  "example" : null
                },
                "quantity" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "description" : "Quantity of the addon. Applicable for addons with `pricing_model`\nother than `flat_fee`\n.\n",
                  "minimum" : 1,
                  "example" : null
                },
                "unit_price" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Amount that will override the Addon's default price. The unit depends on the [type of currency](/docs/api/getting-started)\n.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "on_event" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Event on which this addon will be charged.\n\n* subscription_creation - Addon will be charged on subscription creation.\n* subscription_trial_start - Addon will be charged when the trial period starts.\n* plan_activation - Addon will be charged on plan activation.\n* contract_termination - Addon will be charged on contract termination.\n* subscription_activation - Addon will be charged on subscription activation.\n",
                  "enum" : [ "subscription_creation", "subscription_trial_start", "plan_activation", "subscription_activation", "contract_termination" ],
                  "example" : null
                },
                "charge_once" : {
                  "type" : "boolean",
                  "default" : true,
                  "deprecated" : false,
                  "description" : "If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.\n",
                  "example" : null
                },
                "quantity_in_decimal" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The decimal representation of the quantity of the addon. Returned for quantity-based addons when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "maxLength" : 33,
                  "example" : null
                },
                "unit_price_in_decimal" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The decimal representation of the price or per-unit price of the addon. The value is in major units of the currency. Always returned when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "maxLength" : 39,
                  "example" : null
                }
              },
              "required" : [ "charge_once", "id", "on_event", "quantity", "unit_price" ],
              "example" : null
            },
            "example" : null
          },
          "charged_event_based_addons" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "List of event_based_addons that have already been charged.\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Addon id.\n",
                  "maxLength" : 100,
                  "example" : null
                },
                "last_charged_at" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "Timestamp indicating when this add-on was last charged for this subscription.\n",
                  "example" : null
                }
              },
              "required" : [ "id", "last_charged_at" ],
              "example" : null
            },
            "example" : null
          },
          "coupons" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "List of coupons for this subscription\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "coupon_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Used to uniquely identify the coupon\n",
                  "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`\n[coupons](/docs/api/coupons)\nonly.\n",
                  "example" : null
                },
                "applied_count" : {
                  "type" : "integer",
                  "format" : "int32",
                  "default" : 0,
                  "deprecated" : false,
                  "description" : "Number of times this coupon has been applied for this subscription\n",
                  "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.\n",
                  "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.\n",
            "properties" : {
              "first_name" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The first name of the contact.\n",
                "maxLength" : 150,
                "example" : null
              },
              "last_name" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The last name of the contact.\n",
                "maxLength" : 150,
                "example" : null
              },
              "email" : {
                "type" : "string",
                "format" : "email",
                "deprecated" : false,
                "description" : "The email address.\n",
                "maxLength" : 70,
                "example" : null
              },
              "company" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The company name.\n",
                "maxLength" : 250,
                "example" : null
              },
              "phone" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The phone number.\n",
                "maxLength" : 50,
                "example" : null
              },
              "line1" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Address line 1\n",
                "maxLength" : 150,
                "example" : null
              },
              "line2" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Address line 2\n",
                "maxLength" : 150,
                "example" : null
              },
              "line3" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Address line 3\n",
                "maxLength" : 150,
                "example" : null
              },
              "city" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The name of the city.\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)\nwithout the country prefix. Currently supported for USA, Canada, India and UAE. For instance, for Arizona (USA), set `state_code`\nas `AZ`\n(not `US-AZ`\n). For Tamil Nadu (India), set as `TN`\n(not `IN-TN`\n). For British Columbia (Canada), set as `BC`\n(not `CA-BC`\n). For Dubai (UAE), set as `DU`\n(not `AE-DU`\n).\n",
                "maxLength" : 50,
                "example" : null
              },
              "state" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The state/province name.\n",
                "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)\n.\n",
                "maxLength" : 20,
                "example" : null
              },
              "validation_status" : {
                "type" : "string",
                "default" : "not_validated",
                "deprecated" : false,
                "description" : "The address verification status.\n\n* not_validated - Address is not yet validated.\n* valid - Address was validated successfully.\n* partially_valid - The address is valid for taxability but has not been validated for shipping.\n* invalid - Address is invalid.\n",
                "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\n",
            "properties" : {
              "referral_code" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Referral code if available for the subscription\n",
                "maxLength" : 50,
                "example" : null
              },
              "coupon_code" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Referral coupon code if available for the subscription\n",
                "maxLength" : 50,
                "example" : null
              },
              "referrer_id" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Referrer id if available for the subscription\n",
                "maxLength" : 19,
                "example" : null
              },
              "external_reference_id" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "External reference id in referral system for the subscription\n",
                "maxLength" : 50,
                "example" : null
              },
              "reward_status" : {
                "type" : "string",
                "default" : "pending",
                "deprecated" : false,
                "description" : "Reward status for the referral subscription\n\n* paid - Paid\n* invalid - Invalid\n* pending - Pending\n",
                "enum" : [ "pending", "paid", "invalid" ],
                "example" : null
              },
              "referral_system" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Source referral system for the referral subscription\n\n* referral_saasquatch - Referral Saasquatch\n* referral_candy - Referral Candy\n* friendbuy - Friendbuy\n",
                "enum" : [ "referral_candy", "referral_saasquatch", "friendbuy" ],
                "example" : null
              },
              "account_id" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Referral account id\n",
                "maxLength" : 50,
                "example" : null
              },
              "campaign_id" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Referral campaign id\n",
                "maxLength" : 50,
                "example" : null
              },
              "external_campaign_id" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Referral external campaign id\n",
                "maxLength" : 100,
                "example" : null
              },
              "friend_offer_type" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Friend offer type for the referral camapign\n\n* none - None\n* coupon_code - Coupon Code\n* coupon - Coupon\n",
                "enum" : [ "none", "coupon", "coupon_code" ],
                "example" : null
              },
              "referrer_reward_type" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Referrer reward type for the referral campaign\n\n* none - None\n* custom_revenue_percent_based - Custom Revenue Percent Based\n* referral_direct_reward - Referral Direct Reward\n* custom_promotional_credit - Custom Promotional Credit\n",
                "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\n\n* first_paid_conversion - First Paid Conversion\n* none - None\n* all_invoices - All Invoices\n",
                "enum" : [ "none", "first_paid_conversion", "all_invoices" ],
                "example" : null
              },
              "destination_url" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Destination url for the referral campaign\n",
                "maxLength" : 250,
                "example" : null
              },
              "post_purchase_widget_enabled" : {
                "type" : "boolean",
                "default" : true,
                "deprecated" : false,
                "description" : "Whether post purchase widget is enabled for this campaign\n",
                "example" : null
              }
            },
            "required" : [ "account_id", "campaign_id", "post_purchase_widget_enabled" ],
            "example" : null
          },
          "contract_term" : {
            "type" : "object",
            "deprecated" : false,
            "description" : "Contract terms for this subscription\n",
            "properties" : {
              "id" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Id that uniquely identifies the contract term in the site.\n",
                "maxLength" : 50,
                "example" : null
              },
              "status" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "Current status of contract\n\n* terminated - The contract term was terminated ahead of completion.\n* completed - The contract term has run its full duration.\n* active - An actively running contract term.\n* cancelled -\n  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).\n\n  * the subscription was cancelled due to non-payment.\n",
                "enum" : [ "active", "completed", "cancelled", "terminated" ],
                "example" : null
              },
              "contract_start" : {
                "type" : "integer",
                "format" : "unix-time",
                "deprecated" : false,
                "description" : "The start date of the contract term\n",
                "example" : null
              },
              "contract_end" : {
                "type" : "integer",
                "format" : "unix-time",
                "deprecated" : false,
                "description" : "The end date of the contract term\n",
                "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.\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.\n\n* renew_once -\n  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).\n\n  * The `action_at_term_end` for the new contract term is set to `cancel`.\n* cancel - Contract term completes and subscription is canceled.\n* evergreen - Contract term completes and the subscription renews.\n* renew -\n  * 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).\n  * The `action_at_term_end` for the new contract term is set to `renew`.\n",
                "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)\nof all the invoices raised as part of the contract term. For `active`\ncontract terms, this is a predicted value. The value depends on the [type of currency](/docs/api/currencies).\nIf the subscription was [imported](/docs/api/v2/pcv-1/subscriptions/import-a-subscription)\nwith the contract term, then this value includes the value passed for `total_amount_raised`\n.\n",
                "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`\nis included in the calculation of the total contract value before tax. It's important to note that this value excludes any applicable taxes.\n",
                "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)\n, 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.\n",
                "example" : null
              },
              "created_at" : {
                "type" : "integer",
                "format" : "unix-time",
                "deprecated" : false,
                "description" : "The date when the contract term was created.\n",
                "example" : null
              },
              "subscription_id" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "The [Id](/docs/api/subscriptions/subscription-object#id)\nof the subscription that this contract term is for.\n",
                "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`\ncontract terms.\n",
                "minimum" : 0,
                "example" : null
              }
            },
            "required" : [ "action_at_term_end", "billing_cycle", "contract_end", "contract_start", "created_at", "id", "status", "subscription_id", "total_contract_value", "total_contract_value_before_tax" ],
            "example" : null
          }
        },
        "required" : [ "currency_code", "customer_id", "decommissioned", "deleted", "has_scheduled_advance_invoices", "has_scheduled_changes", "id", "plan_id", "plan_quantity", "status" ],
        "example" : null
      },
      "SubscriptionActivatedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "subscription" : {
                "$ref" : "#/components/schemas/Subscription"
              },
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              },
              "invoice" : {
                "$ref" : "#/components/schemas/Invoice"
              }
            },
            "required" : [ "card", "customer", "invoice", "subscription" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "SubscriptionActivatedWithBackdatingEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "subscription" : {
                "$ref" : "#/components/schemas/Subscription"
              },
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              },
              "invoice" : {
                "$ref" : "#/components/schemas/Invoice"
              },
              "unbilled_charges" : {
                "type" : "array",
                "items" : {
                  "$ref" : "#/components/schemas/UnbilledCharge"
                },
                "example" : null
              }
            },
            "required" : [ "card", "customer", "invoice", "subscription", "unbilled_charges" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "SubscriptionAdvanceInvoiceScheduleAddedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "subscription" : {
                "$ref" : "#/components/schemas/Subscription"
              },
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "advance_invoice_schedules" : {
                "type" : "array",
                "items" : {
                  "$ref" : "#/components/schemas/AdvanceInvoiceSchedule"
                },
                "example" : null
              }
            },
            "required" : [ "advance_invoice_schedules", "customer", "subscription" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "SubscriptionAdvanceInvoiceScheduleRemovedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "subscription" : {
                "$ref" : "#/components/schemas/Subscription"
              },
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "advance_invoice_schedules" : {
                "type" : "array",
                "items" : {
                  "$ref" : "#/components/schemas/AdvanceInvoiceSchedule"
                },
                "example" : null
              }
            },
            "required" : [ "advance_invoice_schedules", "customer", "subscription" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "SubscriptionAdvanceInvoiceScheduleUpdatedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "subscription" : {
                "$ref" : "#/components/schemas/Subscription"
              },
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "advance_invoice_schedules" : {
                "type" : "array",
                "items" : {
                  "$ref" : "#/components/schemas/AdvanceInvoiceSchedule"
                },
                "example" : null
              }
            },
            "required" : [ "advance_invoice_schedules", "customer", "subscription" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "SubscriptionCanceledWithBackdatingEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "subscription" : {
                "$ref" : "#/components/schemas/Subscription"
              },
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              },
              "invoice" : {
                "$ref" : "#/components/schemas/Invoice"
              },
              "credit_notes" : {
                "type" : "array",
                "items" : {
                  "$ref" : "#/components/schemas/CreditNote"
                },
                "example" : null
              },
              "unbilled_charges" : {
                "type" : "array",
                "items" : {
                  "$ref" : "#/components/schemas/UnbilledCharge"
                },
                "example" : null
              }
            },
            "required" : [ "card", "credit_notes", "customer", "invoice", "subscription", "unbilled_charges" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "SubscriptionCancellationReminderEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "subscription" : {
                "$ref" : "#/components/schemas/Subscription"
              },
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              },
              "advance_invoice_schedule" : {
                "$ref" : "#/components/schemas/AdvanceInvoiceSchedule"
              }
            },
            "required" : [ "advance_invoice_schedule", "card", "customer", "subscription" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "SubscriptionCancellationScheduledEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "subscription" : {
                "$ref" : "#/components/schemas/Subscription"
              },
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              },
              "advance_invoice_schedule" : {
                "$ref" : "#/components/schemas/AdvanceInvoiceSchedule"
              }
            },
            "required" : [ "advance_invoice_schedule", "card", "customer", "subscription" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "SubscriptionCancelledEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "subscription" : {
                "$ref" : "#/components/schemas/Subscription"
              },
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              },
              "invoice" : {
                "$ref" : "#/components/schemas/Invoice"
              },
              "credit_notes" : {
                "type" : "array",
                "items" : {
                  "$ref" : "#/components/schemas/CreditNote"
                },
                "example" : null
              },
              "unbilled_charges" : {
                "type" : "array",
                "items" : {
                  "$ref" : "#/components/schemas/UnbilledCharge"
                },
                "example" : null
              }
            },
            "required" : [ "card", "credit_notes", "customer", "invoice", "subscription", "unbilled_charges" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "SubscriptionChangedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "subscription" : {
                "$ref" : "#/components/schemas/Subscription"
              },
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              },
              "invoice" : {
                "$ref" : "#/components/schemas/Invoice"
              },
              "credit_notes" : {
                "type" : "array",
                "items" : {
                  "$ref" : "#/components/schemas/CreditNote"
                },
                "example" : null
              },
              "unbilled_charges" : {
                "type" : "array",
                "items" : {
                  "$ref" : "#/components/schemas/UnbilledCharge"
                },
                "example" : null
              }
            },
            "required" : [ "card", "credit_notes", "customer", "invoice", "subscription", "unbilled_charges" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "SubscriptionChangedWithBackdatingEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "subscription" : {
                "$ref" : "#/components/schemas/Subscription"
              },
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              },
              "invoice" : {
                "$ref" : "#/components/schemas/Invoice"
              },
              "credit_notes" : {
                "type" : "array",
                "items" : {
                  "$ref" : "#/components/schemas/CreditNote"
                },
                "example" : null
              },
              "unbilled_charges" : {
                "type" : "array",
                "items" : {
                  "$ref" : "#/components/schemas/UnbilledCharge"
                },
                "example" : null
              }
            },
            "required" : [ "card", "credit_notes", "customer", "invoice", "subscription", "unbilled_charges" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "SubscriptionChangesScheduledEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "subscription" : {
                "$ref" : "#/components/schemas/Subscription"
              },
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              },
              "advance_invoice_schedule" : {
                "$ref" : "#/components/schemas/AdvanceInvoiceSchedule"
              }
            },
            "required" : [ "advance_invoice_schedule", "card", "customer", "subscription" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "SubscriptionCreatedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "subscription" : {
                "$ref" : "#/components/schemas/Subscription"
              },
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              },
              "invoice" : {
                "$ref" : "#/components/schemas/Invoice"
              },
              "unbilled_charges" : {
                "type" : "array",
                "items" : {
                  "$ref" : "#/components/schemas/UnbilledCharge"
                },
                "example" : null
              }
            },
            "required" : [ "card", "customer", "invoice", "subscription", "unbilled_charges" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "SubscriptionCreatedWithBackdatingEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "subscription" : {
                "$ref" : "#/components/schemas/Subscription"
              },
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              },
              "invoice" : {
                "$ref" : "#/components/schemas/Invoice"
              },
              "unbilled_charges" : {
                "type" : "array",
                "items" : {
                  "$ref" : "#/components/schemas/UnbilledCharge"
                },
                "example" : null
              }
            },
            "required" : [ "card", "customer", "invoice", "subscription", "unbilled_charges" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "SubscriptionDeletedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "subscription" : {
                "$ref" : "#/components/schemas/Subscription"
              },
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              },
              "advance_invoice_schedule" : {
                "$ref" : "#/components/schemas/AdvanceInvoiceSchedule"
              }
            },
            "required" : [ "advance_invoice_schedule", "card", "customer", "subscription" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "SubscriptionEstimate" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 50,
            "example" : null
          },
          "currency_code" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 3,
            "example" : null
          },
          "status" : {
            "type" : "string",
            "deprecated" : false,
            "enum" : [ "future", "in_trial", "active", "non_renewing", "paused", "cancelled", "transferred" ],
            "example" : null
          },
          "trial_end_action" : {
            "type" : "string",
            "deprecated" : false,
            "enum" : [ "site_default", "plan_default", "activate_subscription", "cancel_subscription" ],
            "example" : null
          },
          "next_billing_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "example" : null
          },
          "pause_date" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "example" : null
          },
          "resume_date" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "example" : null
          },
          "shipping_address" : {
            "type" : "object",
            "deprecated" : false,
            "properties" : {
              "first_name" : {
                "type" : "string",
                "deprecated" : false,
                "maxLength" : 150,
                "example" : null
              },
              "last_name" : {
                "type" : "string",
                "deprecated" : false,
                "maxLength" : 150,
                "example" : null
              },
              "email" : {
                "type" : "string",
                "format" : "email",
                "deprecated" : false,
                "maxLength" : 70,
                "example" : null
              },
              "company" : {
                "type" : "string",
                "deprecated" : false,
                "maxLength" : 250,
                "example" : null
              },
              "phone" : {
                "type" : "string",
                "deprecated" : false,
                "maxLength" : 50,
                "example" : null
              },
              "line1" : {
                "type" : "string",
                "deprecated" : false,
                "maxLength" : 150,
                "example" : null
              },
              "line2" : {
                "type" : "string",
                "deprecated" : false,
                "maxLength" : 150,
                "example" : null
              },
              "line3" : {
                "type" : "string",
                "deprecated" : false,
                "maxLength" : 150,
                "example" : null
              },
              "city" : {
                "type" : "string",
                "deprecated" : false,
                "maxLength" : 50,
                "example" : null
              },
              "state_code" : {
                "type" : "string",
                "deprecated" : false,
                "maxLength" : 50,
                "example" : null
              },
              "state" : {
                "type" : "string",
                "deprecated" : false,
                "maxLength" : 50,
                "example" : null
              },
              "country" : {
                "type" : "string",
                "deprecated" : false,
                "maxLength" : 50,
                "example" : null
              },
              "zip" : {
                "type" : "string",
                "deprecated" : false,
                "maxLength" : 20,
                "example" : null
              },
              "validation_status" : {
                "type" : "string",
                "default" : "not_validated",
                "deprecated" : false,
                "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
                "example" : null
              }
            },
            "example" : null
          },
          "contract_term" : {
            "type" : "object",
            "deprecated" : false,
            "properties" : {
              "id" : {
                "type" : "string",
                "deprecated" : false,
                "maxLength" : 50,
                "example" : null
              },
              "status" : {
                "type" : "string",
                "deprecated" : false,
                "enum" : [ "active", "completed", "cancelled", "terminated" ],
                "example" : null
              },
              "contract_start" : {
                "type" : "integer",
                "format" : "unix-time",
                "deprecated" : false,
                "example" : null
              },
              "contract_end" : {
                "type" : "integer",
                "format" : "unix-time",
                "deprecated" : false,
                "example" : null
              },
              "billing_cycle" : {
                "type" : "integer",
                "format" : "int32",
                "deprecated" : false,
                "minimum" : 0,
                "example" : null
              },
              "action_at_term_end" : {
                "type" : "string",
                "default" : "renew",
                "deprecated" : false,
                "enum" : [ "renew", "evergreen", "cancel", "renew_once" ],
                "example" : null
              },
              "total_contract_value" : {
                "type" : "integer",
                "format" : "int64",
                "default" : 0,
                "deprecated" : false,
                "minimum" : 0,
                "example" : null
              },
              "total_contract_value_before_tax" : {
                "type" : "integer",
                "format" : "int64",
                "default" : 0,
                "deprecated" : false,
                "minimum" : 0,
                "example" : null
              },
              "cancellation_cutoff_period" : {
                "type" : "integer",
                "format" : "int32",
                "deprecated" : false,
                "example" : null
              },
              "created_at" : {
                "type" : "integer",
                "format" : "unix-time",
                "deprecated" : false,
                "example" : null
              },
              "subscription_id" : {
                "type" : "string",
                "deprecated" : false,
                "maxLength" : 50,
                "example" : null
              },
              "remaining_billing_cycles" : {
                "type" : "integer",
                "format" : "int32",
                "deprecated" : false,
                "minimum" : 0,
                "example" : null
              }
            },
            "required" : [ "action_at_term_end", "billing_cycle", "contract_end", "contract_start", "created_at", "id", "status", "subscription_id", "total_contract_value", "total_contract_value_before_tax" ],
            "example" : null
          }
        },
        "required" : [ "currency_code" ],
        "example" : null
      },
      "SubscriptionHistory" : {
        "type" : "object",
        "description" : "This resource returns the subscription history.\n",
        "properties" : {
          "item_price_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The unique identifier of the item price.\n",
            "maxLength" : 100,
            "example" : null
          },
          "item_type" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Type of items.\n\n* addon - addon\n* plan - plan\n",
            "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.\n",
            "example" : null
          },
          "active_to" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp to indicate till when this item was attached to the subscription.\n",
            "example" : null
          },
          "created_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp to indicate when this subscription was created.\n",
            "example" : null
          },
          "item_unit_amount_in_cents" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "example" : null
          },
          "actual_item_unit_amount_in_cents" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "example" : null
          },
          "item_amount_in_cents" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "example" : null
          },
          "actual_item_amount_in_cents" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "example" : null
          },
          "rating_group_id" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 50,
            "example" : null
          }
        },
        "example" : null
      },
      "SubscriptionItemsRenewedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "subscription" : {
                "$ref" : "#/components/schemas/Subscription"
              },
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              },
              "invoice" : {
                "$ref" : "#/components/schemas/Invoice"
              },
              "credit_notes" : {
                "type" : "array",
                "items" : {
                  "$ref" : "#/components/schemas/CreditNote"
                },
                "example" : null
              },
              "unbilled_charges" : {
                "type" : "array",
                "items" : {
                  "$ref" : "#/components/schemas/UnbilledCharge"
                },
                "example" : null
              }
            },
            "required" : [ "card", "credit_notes", "customer", "invoice", "subscription", "unbilled_charges" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "SubscriptionMovedInEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "subscription" : {
                "$ref" : "#/components/schemas/Subscription"
              }
            },
            "required" : [ "subscription" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "SubscriptionMovedOutEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "subscription" : {
                "$ref" : "#/components/schemas/Subscription"
              }
            },
            "required" : [ "subscription" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "SubscriptionMovementFailedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "subscription" : {
                "$ref" : "#/components/schemas/Subscription"
              }
            },
            "required" : [ "subscription" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "SubscriptionPauseScheduledEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "subscription" : {
                "$ref" : "#/components/schemas/Subscription"
              },
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              },
              "advance_invoice_schedule" : {
                "$ref" : "#/components/schemas/AdvanceInvoiceSchedule"
              }
            },
            "required" : [ "advance_invoice_schedule", "card", "customer", "subscription" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "SubscriptionPausedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "subscription" : {
                "$ref" : "#/components/schemas/Subscription"
              },
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              },
              "invoice" : {
                "$ref" : "#/components/schemas/Invoice"
              },
              "credit_notes" : {
                "type" : "array",
                "items" : {
                  "$ref" : "#/components/schemas/CreditNote"
                },
                "example" : null
              },
              "unbilled_charges" : {
                "type" : "array",
                "items" : {
                  "$ref" : "#/components/schemas/UnbilledCharge"
                },
                "example" : null
              }
            },
            "required" : [ "card", "credit_notes", "customer", "invoice", "subscription", "unbilled_charges" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "SubscriptionPreview" : {
        "type" : "object",
        "description" : "This resource returns subscription preview attributes.\n",
        "properties" : {
          "billing_event" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Describes the time in the subscription lifecycle when the charge is to occur.\n\n* subscription_changed - Subscription Changed\n* subscription_resumed - Subscription Resumed\n* subscription_renewed - Subscription Renewed\n* subscription_activated - Subscription Activated\n* subscription_cancelled - Subscription Cancelled\n* subscription_started - Subscription Started\n* subscription_paused - Subscription Paused\n* subscription_created - Subscription Created\n",
            "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.\n",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp indicate when the event was occurred.\n",
            "example" : null
          },
          "subscription" : {
            "type" : "object",
            "additionalProperties" : true,
            "deprecated" : false,
            "description" : "JSON object representing subscription\n",
            "example" : null
          },
          "invoices" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "JSON object representing invoice\n",
            "items" : {
              "example" : null
            },
            "example" : null
          },
          "credit_notes" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "JSON object representing credit notes\n",
            "items" : {
              "example" : null
            },
            "example" : null
          },
          "unbilled_charges" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "Represents the preview of the unbilled charges generated during 'estimate' operation.\n",
            "items" : {
              "example" : null
            },
            "example" : null
          }
        },
        "required" : [ "subscription" ],
        "example" : null
      },
      "SubscriptionReactivatedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "subscription" : {
                "$ref" : "#/components/schemas/Subscription"
              },
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              },
              "invoice" : {
                "$ref" : "#/components/schemas/Invoice"
              },
              "unbilled_charges" : {
                "type" : "array",
                "items" : {
                  "$ref" : "#/components/schemas/UnbilledCharge"
                },
                "example" : null
              }
            },
            "required" : [ "card", "customer", "invoice", "subscription", "unbilled_charges" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "SubscriptionReactivatedWithBackdatingEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "subscription" : {
                "$ref" : "#/components/schemas/Subscription"
              },
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              },
              "invoice" : {
                "$ref" : "#/components/schemas/Invoice"
              },
              "unbilled_charges" : {
                "type" : "array",
                "items" : {
                  "$ref" : "#/components/schemas/UnbilledCharge"
                },
                "example" : null
              }
            },
            "required" : [ "card", "customer", "invoice", "subscription", "unbilled_charges" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "SubscriptionRenewalReminderEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "subscription" : {
                "$ref" : "#/components/schemas/Subscription"
              },
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              },
              "advance_invoice_schedule" : {
                "$ref" : "#/components/schemas/AdvanceInvoiceSchedule"
              }
            },
            "required" : [ "advance_invoice_schedule", "card", "customer", "subscription" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "SubscriptionRenewedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "subscription" : {
                "$ref" : "#/components/schemas/Subscription"
              },
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              },
              "invoice" : {
                "$ref" : "#/components/schemas/Invoice"
              },
              "unbilled_charges" : {
                "type" : "array",
                "items" : {
                  "$ref" : "#/components/schemas/UnbilledCharge"
                },
                "example" : null
              }
            },
            "required" : [ "card", "customer", "invoice", "subscription", "unbilled_charges" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "SubscriptionResumedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "subscription" : {
                "$ref" : "#/components/schemas/Subscription"
              },
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              },
              "invoice" : {
                "$ref" : "#/components/schemas/Invoice"
              },
              "unbilled_charges" : {
                "type" : "array",
                "items" : {
                  "$ref" : "#/components/schemas/UnbilledCharge"
                },
                "example" : null
              }
            },
            "required" : [ "card", "customer", "invoice", "subscription", "unbilled_charges" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "SubscriptionResumptionScheduledEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "subscription" : {
                "$ref" : "#/components/schemas/Subscription"
              },
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              },
              "advance_invoice_schedule" : {
                "$ref" : "#/components/schemas/AdvanceInvoiceSchedule"
              }
            },
            "required" : [ "advance_invoice_schedule", "card", "customer", "subscription" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "SubscriptionScheduledCancellationRemovedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "subscription" : {
                "$ref" : "#/components/schemas/Subscription"
              },
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              },
              "advance_invoice_schedule" : {
                "$ref" : "#/components/schemas/AdvanceInvoiceSchedule"
              }
            },
            "required" : [ "advance_invoice_schedule", "card", "customer", "subscription" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "SubscriptionScheduledChange" : {
        "type" : "object",
        "properties" : {
          "action_type" : {
            "type" : "string",
            "deprecated" : false,
            "enum" : [ "cancel", "pause", "reactivate" ],
            "example" : null
          },
          "data" : {
            "type" : "string",
            "deprecated" : false,
            "maxLength" : 65000,
            "example" : null
          },
          "created_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "example" : null
          },
          "modified_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "example" : null
          }
        },
        "required" : [ "action_type", "created_at", "modified_at" ],
        "example" : null
      },
      "SubscriptionScheduledChangesRemovedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "subscription" : {
                "$ref" : "#/components/schemas/Subscription"
              },
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              },
              "advance_invoice_schedule" : {
                "$ref" : "#/components/schemas/AdvanceInvoiceSchedule"
              }
            },
            "required" : [ "advance_invoice_schedule", "card", "customer", "subscription" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "SubscriptionScheduledPauseRemovedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "subscription" : {
                "$ref" : "#/components/schemas/Subscription"
              },
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              },
              "advance_invoice_schedule" : {
                "$ref" : "#/components/schemas/AdvanceInvoiceSchedule"
              }
            },
            "required" : [ "advance_invoice_schedule", "card", "customer", "subscription" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "SubscriptionScheduledResumptionRemovedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "subscription" : {
                "$ref" : "#/components/schemas/Subscription"
              },
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              },
              "advance_invoice_schedule" : {
                "$ref" : "#/components/schemas/AdvanceInvoiceSchedule"
              }
            },
            "required" : [ "advance_invoice_schedule", "card", "customer", "subscription" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "SubscriptionShippingAddressUpdatedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "subscription" : {
                "$ref" : "#/components/schemas/Subscription"
              },
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              },
              "advance_invoice_schedule" : {
                "$ref" : "#/components/schemas/AdvanceInvoiceSchedule"
              }
            },
            "required" : [ "advance_invoice_schedule", "card", "customer", "subscription" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "SubscriptionStartedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "subscription" : {
                "$ref" : "#/components/schemas/Subscription"
              },
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              },
              "invoice" : {
                "$ref" : "#/components/schemas/Invoice"
              }
            },
            "required" : [ "card", "customer", "invoice", "subscription" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "SubscriptionTrialEndReminderEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "subscription" : {
                "$ref" : "#/components/schemas/Subscription"
              },
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              },
              "advance_invoice_schedule" : {
                "$ref" : "#/components/schemas/AdvanceInvoiceSchedule"
              }
            },
            "required" : [ "advance_invoice_schedule", "card", "customer", "subscription" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "SubscriptionTrialExtendedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "subscription" : {
                "$ref" : "#/components/schemas/Subscription"
              },
              "customer" : {
                "$ref" : "#/components/schemas/Customer"
              },
              "card" : {
                "$ref" : "#/components/schemas/Card"
              },
              "advance_invoice_schedule" : {
                "$ref" : "#/components/schemas/AdvanceInvoiceSchedule"
              }
            },
            "required" : [ "advance_invoice_schedule", "card", "customer", "subscription" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "TaxExemptReason" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "tax_not_configured", "region_non_taxable", "export", "customer_exempt", "product_exempt", "zero_rated", "reverse_charge", "high_value_physical_goods", "zero_value_item", "tax_not_configured_external_provider" ],
        "example" : null
      },
      "TaxJurisType" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "country", "federal", "state", "county", "city", "special", "unincorporated", "other" ],
        "example" : null
      },
      "TaxOverrideReason" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "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_`.\nFor example, `tax_wh_16BdDXSlbu4uV1Ee6`\n.\n",
            "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.\n",
            "maxLength" : 100,
            "example" : null
          },
          "description" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The description for this tax withheld.\n",
            "maxLength" : 65000,
            "example" : null
          },
          "date" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Date or time associated with the tax withheld.\n",
            "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)\n.\n",
            "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.\n",
        "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.\n",
            "maxLength" : 50,
            "example" : null
          },
          "reference_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Identifier provided by the gateway to reference that specific card.\n",
            "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.\n\nPass 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.\n",
            "example" : null
          }
        },
        "required" : [ "gateway", "reference_id", "type" ],
        "example" : null
      },
      "ThunkingPlan" : {
        "type" : "object",
        "description" : "This resource is used to return thunking plan.\n",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The identifier for the item price. It is unique and immutable.\n",
            "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`\nis not provided, this is also used in customer-facing pages and documents such as [invoices](/docs/api/invoices)\nand [hosted pages](/docs/api/hosted_pages)\n.\n",
            "maxLength" : 100,
            "example" : null
          },
          "item_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The id of the item that the item price belongs to.\n",
            "maxLength" : 100,
            "example" : null
          },
          "description" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Description of the item price.\n",
            "maxLength" : 2000,
            "example" : null
          },
          "status" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The status of the item price.\n\n* 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.\n* active - The item price can be used in subscriptions.\n* deleted -\n  Indicates that the item price has been deleted. The `id`\n  and `name`\n  can be reused.\n",
            "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)\nand [hosted pages](/docs/api/hosted_pages).\nIf not provided, then `name`\nis used\n",
            "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.\n\n* tiered - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.\n* per_unit - A fixed price per unit quantity.\n* flat_fee - A fixed price that is not quantity-based.\n* volume - The per unit price is based on the tier that the total quantity falls in.\n* stairstep - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.\n",
            "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`.\nWhen the pricing model is `per_unit`\n, 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)\n.\n",
            "minimum" : 0,
            "example" : null
          },
          "price_in_decimal" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The price of the item when the pricing_model is `flat_fee`.\nWhen the pricing model is `per_unit`\n, 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)\nis enabled.\n",
            "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.\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`\ncannot be changed. The `period`\nis mandatory when the item `type`\nis `plan`\nor `addon`\n",
            "minimum" : 1,
            "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`\nis `plan`\nor `addon`\n\n* month - A period of 1 calendar month.\n* day - A period of 24 hours.\n* week - A period of 7 days.\n* year - A period of 1 calendar year.\n",
            "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`\ns. You can also set [trial periods for addons](https://www.chargebee.com/docs/2.0/addons-trial.html)\n; 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)\nto enable that feature.\n",
            "minimum" : 0,
            "example" : null
          },
          "trial_period_unit" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The unit of time for `trial_period`\n.\n\n* month - A period of 1 calendar month.\n* day - A period of 24 hours.\n",
            "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/trial_periods.html#how-to-define-the-end-of-trial-actions-for-subscriptions)\nhas been enabled for the site. Specifies the operation to be carried out for the subscription once the trial ends. Whenever the `item.type`\nis `plan`\nand 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)\n.\n\n* cancel_subscription - The subscription cancels.\n* activate_subscription - The subscription activates and charges are raised for non-metered items.\n* site_default -\n  The action [configured for the site](https://www.chargebee.com/docs/trial_periods.html#how-to-define-the-end-of-trial-actions-for-subscriptions)\n  at the time when the trial ends, takes effect.\n",
            "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.\n",
            "minimum" : 1,
            "example" : null
          },
          "shipping_period_unit" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Defines the shipping frequency in association with shipping period.\n\n* year - A period of 1 calendar year.\n* day - A period of 24 hours.\n* week - A period of 7 days.\n* month - A period of 1 calendar month.\n",
            "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). 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.\nIf subscriptions, invoices or [differential prices](/docs/api/differential_prices)\nexist for this item price, `billing_cycles`\ncannot be changed.\n",
            "minimum" : 1,
            "example" : null
          },
          "free_quantity" : {
            "type" : "integer",
            "format" : "int32",
            "default" : 0,
            "deprecated" : false,
            "description" : "Free quantity the subscriptions of this item_price will have. Only the quantity more than this will be charged for the subscription.\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)\nis enabled.\n",
            "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",
            "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\n",
            "example" : null
          },
          "created_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp indicating when this item price was created\n",
            "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.\n\n* 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.\n* charge -\n  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)\n  without being applied to a subscription.\n* addon - A recurring component that can be added to a subscription in addition to its plan.\n",
            "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.\n",
            "example" : null
          },
          "giftable" : {
            "type" : "boolean",
            "default" : false,
            "deprecated" : false,
            "description" : "Specifies if gift subscriptions can be created for this item.\n",
            "example" : null
          },
          "redirect_url" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "If `enabled_for_checkout`\n, then the URL to be redirected to once the checkout is complete. This attribute is only available for plan-items.\n",
            "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.\n",
            "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).\nApplies 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)\n.\n",
            "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`\nand 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`\n.\n",
            "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)\nor [Update an attached item](/docs/api/attached_items/update-an-attached-item)\nAPI.\n\n* all - all addon-items and charge-items are applicable to this plan-item.\n* restricted -\n  only the addon-items or charge-items provided in `applicable_items`\n  can be applied to this plan-item.\n",
            "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.\n",
            "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)\n, [invoices](/docs/api/invoices)\nand [quotes](/docs/api/quotes).\nExamples follow:\n\n* \"user\" for a cloud-collaboration platform.\n* \"GB\" for a data service.\n* \"issue\" for a magazine.\n",
            "maxLength" : 30,
            "example" : null
          },
          "item_name" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Name of the items.\n",
            "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.\n",
            "maxLength" : 500,
            "example" : null
          },
          "item_updated_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp indicating when the item was last updated.\n",
            "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.\n",
            "maxLength" : 100,
            "example" : null
          },
          "sku" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "This maps to the sku or product name in the accounting integration.\n",
            "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.\n",
            "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 )\n\n* [**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.`\n* [**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: `::...`\n* [**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.`\n* [**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.\n",
            "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 )\n\n* [**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`\n* [**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`\n* [**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`\n* [**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.\n",
            "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 )\n\n* [**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.`\n* [**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.\n",
            "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 )\n\n* [**NetSuite:**](https://www.chargebee.com/docs/2.0/netsuite.html ) Provide the \"Revenue Recognition Rule Id\" for the product from NetSuite.\n* [**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.\n",
            "maxLength" : 100,
            "example" : null
          },
          "tax_profile_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The tax profile of the item price.\n",
            "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)\nfor the item price. Applicable only if you use the [AvaTax for Communications integration](https://www.chargebee.com/docs/2.0/avatax-for-communication.html)\n.\n\n* retail - Transaction is a sale to an end user\n* vendor_use - Transaction is for an item that is subject to vendor use tax\n* consumed - Transaction is for an item that is consumed directly\n* wholesale - Transaction is a sale to another company that will resell your product or service to another consumer\n",
            "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)\nfor the item price. Applicable only if you use the [AvaTax for Communications integration](https://www.chargebee.com/docs/2.0/avatax-for-communication.html)\n.\n",
            "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)\nfor the item price. Applicable only if you use the [AvaTax for Communications integration](https://www.chargebee.com/docs/2.0/avatax-for-communication.html)\n.\n",
            "example" : null
          },
          "avalara_tax_code" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The [Avalara tax codes](https://taxcode.avatax.avalara.com)\nfor the item price. Applicable only if you use [AvaTax for Sales integration](https://www.chargebee.com/docs/2.0/avatax-for-sales.html)\n.\n",
            "maxLength" : 50,
            "example" : null
          },
          "hsn_code" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The [HSN code](https://cbic-gst.gov.in/gst-goods-services-rates.html)\nto which the item is mapped for calculating the customer's tax in India. Applicable only when both of the following conditions are true:\n\n* [**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.)\n* The [**AvaTax for Sales** integration](https://www.chargebee.com/docs/avalara.html) has been enabled in Chargebee.\n",
            "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)\nfor the item price. Applicable only if you use [TaxJar integration](https://www.chargebee.com/docs/2.0/taxjar.html)\n.\n",
            "maxLength" : 50,
            "example" : null
          },
          "setup_cost" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "One-time setup fee charged as part of the first invoice.\n",
            "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.\n\n* all - All addons are applicable with this plan.\n* restricted - Only addons marked as 'applicable_addons' are applicable with the plan.\n",
            "enum" : [ "all", "restricted" ],
            "example" : null
          },
          "charge_type" : {
            "type" : "string",
            "default" : "recurring",
            "deprecated" : false,
            "description" : "Type of charge\n\n* non_recurring - Charged immediately and only once every time it is applied.\n* recurring - Charges are automatically applied in sync with the billing frequency of subscription.\n",
            "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\n",
            "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.\n\nYou 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.\n\nView this [doc](https://www.chargebee.com/docs/time-machine.html) for more details.\n\n**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**.\n",
        "properties" : {
          "name" : {
            "type" : "string",
            "default" : "delorean",
            "deprecated" : false,
            "description" : "The name of the time machine. Currently only **delorean**\nis allowed\n",
            "maxLength" : 50,
            "example" : null
          },
          "time_travel_status" : {
            "type" : "string",
            "default" : "not_enabled",
            "deprecated" : false,
            "description" : "The current status of time travel\n\n* succeeded - Time travel has succeeded.\n* not_enabled - Time travel has not been enabled for the site\n* failed -\n  Time travel has failed. Check the failure code and failure reason attributes for further details.\n  **Note:**\n  The time machine needs to be reset by starting afresh again.\n* in_progress - Time travel is in progress\n",
            "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'\n",
            "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)\n",
            "example" : null
          },
          "failure_code" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The failure code. This will follow the api error code convention\n",
            "maxLength" : 250,
            "example" : null
          },
          "failure_reason" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The more descriptive failure reason.\n",
            "maxLength" : 250,
            "example" : null
          },
          "error_json" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The failure details as error json.\n",
            "maxLength" : 1000,
            "example" : null
          }
        },
        "required" : [ "destination_time", "genesis_time", "name", "time_travel_status" ],
        "example" : null
      },
      "Token" : {
        "type" : "object",
        "description" : "Tokenization holds sensitive payment information into a unique token for a secure transaction. The token does not expose any actual payment details.\n",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Identifier of the Chargebee Token\n",
            "maxLength" : 40,
            "example" : null
          },
          "gateway" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Name of the gateway this token is stored in.\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* tco - 2Checkout is a payment gateway.\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* 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* 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* first_data_global - First Data Global Gateway Virtual Terminal Account\n* exact - Exact Payments is a payment gateway.\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* quickbooks - Intuit QuickBooks Payments gateway\n* wepay - WePay is a payment gateway.\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* 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",
            "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.\n",
            "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\n\n* new - new\n* consumed - The token is already used\n* expired - expired\n",
            "enum" : [ "new", "expired", "consumed" ],
            "example" : null
          },
          "id_at_vault" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The id with which this token is referred in gateway\n",
            "maxLength" : 65000,
            "example" : null
          },
          "vault" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Name of the gateway/vault provider where the payment method is tokenized\n\n* gateway - gateway\n* spreedly - spreedly\n",
            "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.\n",
            "maxLength" : 50,
            "example" : null
          },
          "resource_version" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Version number of this resource. The `resource_version`\nis 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.\n",
            "example" : null
          },
          "updated_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp indicating when this token resource was last updated.\n",
            "example" : null
          },
          "created_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp indicating when this token resource is created.\n",
            "example" : null
          },
          "expired_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp indicating when this token is expired\n",
            "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)\nevent that has happened in your account.\n",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Uniquely identifies the transaction.\n",
            "maxLength" : 40,
            "example" : null
          },
          "customer_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Identifier of the customer for which this transaction is made\n",
            "maxLength" : 50,
            "example" : null
          },
          "subscription_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Identifier of the subscription for which this transaction is made.\n",
            "maxLength" : 50,
            "example" : null
          },
          "gateway_account_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The gateway account used for this transaction\n",
            "maxLength" : 50,
            "example" : null
          },
          "payment_source_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Identifier of the payment source for which this transaction is made\n",
            "maxLength" : 40,
            "example" : null
          },
          "payment_method" : {
            "type" : "string",
            "default" : "card",
            "deprecated" : false,
            "description" : "The payment method of this transaction\n\n* fpx - Payments made via FPX.\n* naver_pay - Payments made via Naver Pay.\n* qpay - Payments made via Qpay.\n* unionpay - Unionpay\n* paypay - PayPay\n* online_banking_poland - Online Banking Poland\n* upi - upi\n* payconiq_by_bancontact - Payments made via Payconiq by Bancontact.\n* kakao_pay - Payments made via Kakao Pay.\n* momo - Payments made via MoMo.\n* check - Check\n* payme - Payments made via PayMe\n* cash_app_pay - Payments made via Cash App Pay.\n* custom - Custom\n* mercado_pago - Payments made via Mercado Pago.\n* amazon_payments - Amazon Payments\n* boleto - boleto\n* klarna - Payments made via Klarna.\n* direct_debit - Direct Debit\n* klarna_pay_now - Klarna Pay Now\n* sepa_instant_transfer - Sepa Instant Transfer\n* p24 - Payments made via Przelewy24 (P24).\n* apple_pay - Apple Pay\n* thai_qr - Payments made via Thai QR.\n* wechat_pay - Payments made via WeChat Pay.\n* twint - Payments made via Twint\n* kbc_payment_button - KBC Payment Button\n* bancontact - Bancontact\n* faster_payments - Faster Payments\n* go_pay - Payments made via GoPay\n* stablecoin - Payments made via Stablecoin.\n* venmo - Venmo\n* wero - Payments made via Wero.\n* touch_n_go - Payments made via Touch 'n Go.\n* bank_transfer - Bank Transfer\n* paypal_express_checkout - Paypal Express Checkout\n* electronic_payment_standard - Electronic Payment Standard\n* other - Payment Methods other than the above types\n* tamara - Payments made via Tamara.\n* trustly - Trustly\n* ach_credit - ACH Credit\n* sepa_credit - SEPA Credit\n* alipay_hk - Payments made via Alipay HK.\n* affirm_pay - Payments made via Affirm Pay.\n* rakuten_pay - Payments made via Rakuten Pay.\n* card - Card\n* gcash - Payments made via GCash.\n* ideal - IDEAL\n* nupay - Payments made via NuPay.\n* chargeback -\n  Only applicable for a transaction of [type](/docs/api/transactions/transaction-object#type)\n  = `refund`.\n  This value is set by Chargebee when an automated [chargeback](https://www.chargebee.com/docs/chargeback.html#chargeback-process)\n  occurs. You can also set this explicitly when [recording a refund](/docs/api/transactions/record-an-offline-refund)\n  .\n* automated_bank_transfer - Automated Bank Transfer\n* ovo - Payments made via OVO.\n* google_pay - Google Pay\n* dana - Payments made via Dana.\n* nequi - Payments made via Nequi.\n* netbanking_emandates - netbanking_emandates\n* blik - Payments made via BLIK.\n* pay_to - PayTo\n* pay_by_bank - Pay By Bank\n* dotpay - Dotpay\n* alipay - Payments made via Alipay.\n* sofort - Sofort\n* swish - Payments made via Swish\n* grab_pay - Payments made via GrabPay\n* pix - Pix\n* giropay - giropay\n* pay_co - Payments made via PayCo\n* revolut_pay - Payments made via Revolut Pay.\n* cash - Cash\n* after_pay - Payments made via Afterpay\n* south_korean_cards - Payments made via South Korean Cards\n* picpay - Payments made via PicPay.\n",
            "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)\n= `check`\n.\n",
            "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 end-to-end 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.\n\n* authorization -\n  The transaction represents an authorization for capturing the [amount](/docs/api/transactions/transaction-object#amount)\n  from the customer's [payment_source](/docs/api/payment_sources)\n  .\n* payment -\n  The transaction represents capture of [amount](/docs/api/transactions/transaction-object#amount)\n  from the customer's [payment_source](/docs/api/payment_sources)\n  .\n* refund -\n  The transaction represents a refund of [amount](/docs/api/transactions/transaction-object#amount)\n  to the customer's [payment_source](/docs/api/payment_sources)\n  .\n* payment_reversal - Indicates a reversal transaction.\n",
            "enum" : [ "authorization", "payment", "refund", "payment_reversal" ],
            "example" : null
          },
          "date" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Indicates when this transaction occurred.\n",
            "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.\n",
            "example" : null
          },
          "exchange_rate" : {
            "type" : "number",
            "format" : "decimal",
            "deprecated" : false,
            "description" : "Exchange rate used for base currency conversion\n",
            "maximum" : 1000000000,
            "minimum" : 0.0000000010,
            "example" : null
          },
          "currency_code" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The currency code (ISO 4217 format) for the transaction.\n",
            "maxLength" : 3,
            "example" : null
          },
          "amount" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Amount for this transaction.\n",
            "minimum" : 0,
            "example" : null
          },
          "id_at_gateway" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The id with which this transaction is referred in gateway.\n",
            "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/v2/pcv-1/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/v2/pcv-1/transactions/transaction-object#status)\n  transaction to be reconciled at par with the gateway.  \n  [Learn more](https://www.chargebee.com/docs/payments/1.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.\n\n* suspicious - The transaction has been identified as potentially fraudulent by the gateway\n* safe - The transaction has been marked as safe\n* fraudulent - The transaction has been marked as fraudulent\n",
            "enum" : [ "safe", "suspicious", "fraudulent" ],
            "example" : null
          },
          "initiator_type" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Marker for on-session payments (3DS). null indicates 'merchant'.\n\n* merchant - Payment initiated on stored payment method by the merchant\n* customer - Customer initiated 3DS payment\n",
            "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.\n",
            "example" : null
          },
          "authorization_reason" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Type of authorization transaction.\n\n* scheduled_capture -\n  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](/docs/api/invoices/invoice-object#linked_payments)\n  .\n* verification - The transaction has been created for payment method verification.\n* blocking_funds - The transaction has been created to block the funds from payment method.\n",
            "enum" : [ "blocking_funds", "verification", "scheduled_capture" ],
            "example" : null
          },
          "error_code" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Error code received from the payment gateway on failure.\n",
            "maxLength" : 100,
            "example" : null
          },
          "error_text" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Error message received from the payment gateway on failure.\n",
            "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.\n",
            "example" : null
          },
          "resource_version" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Version number of this resource. The `resource_version`\nis 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.\n",
            "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.\n",
            "example" : null
          },
          "fraud_reason" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Short description why the transaction was marked as fraud/suspicious\n",
            "maxLength" : 250,
            "example" : null
          },
          "custom_payment_method_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Identifier of the custom payment method of this transaction.\n",
            "maxLength" : 50,
            "example" : null
          },
          "amount_unused" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "This is the part of the `amount`\nwhich has not been invoiced yet and is therefore added to [excess_payments](/docs/api/customers/customer-object#excess_payments)\nfor the customer. Applicable only for a transaction of `type`\n= `payment`\n.\n",
            "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\n",
            "maxLength" : 20,
            "example" : null
          },
          "reference_transaction_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "This is the `id`\nof the offline transaction that is being refunded or reversed. Applicable only for transaction of `type`\n= `refund`\nor `payment_reversal`\n.\n",
            "maxLength" : 40,
            "example" : null
          },
          "refunded_txn_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "This is the `id`\nof the transaction (always of `type`\n= `payment`\n) being refunded. Applicable only for transaction of `type`\n= `refund`\n.\n",
            "maxLength" : 40,
            "example" : null
          },
          "reference_authorization_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "This is the `id`\nof the transaction (always of `type`\n= `authorization`\n) which authorizes the payment being captured. Applicable only for transaction of `type`\n= `payment`\n.\n",
            "maxLength" : 40,
            "example" : null
          },
          "amount_capturable" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "This is the part of the authorized `amount`\nthat is yet to be captured. The payment capture is recorded as a transaction of of `type`\n= `payment`.\nApplicable only for a transaction of `type`\n= `authorization`\n.\n",
            "minimum" : 0,
            "example" : null
          },
          "reversal_transaction_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Reversal transaction id. Applicable only for payment transactions.\n",
            "maxLength" : 40,
            "example" : null
          },
          "deleted" : {
            "type" : "boolean",
            "deprecated" : false,
            "description" : "Indicates that this resource has been deleted.\n",
            "example" : null
          },
          "iin" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "First 6 digits of the card payment method.\n",
            "maxLength" : 6,
            "minLength" : 4,
            "example" : null
          },
          "last4" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Last 4 digits of the transaction.\n",
            "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)\n.\n",
            "maxLength" : 500,
            "example" : null
          },
          "business_entity_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity.  \n**Note**\n\n[Multiple Business Entities](/docs/api/getting-started) is a feature available only on Product Catalog 2.0.\n",
            "maxLength" : 50,
            "example" : null
          },
          "payment_method_details" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Payment method details of the corresponding transaction\n",
            "example" : null
          },
          "custom_payment_method_name" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Name of the custom payment method of this transaction.\n",
            "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.\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "invoice_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Identifier for the invoice.\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "applied_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "The transaction amount applied to this invoice\n",
                  "minimum" : 0,
                  "example" : null
                },
                "applied_at" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "Timestamp at which the transaction is applied.\n",
                  "example" : null
                },
                "invoice_date" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "The date this invoice is issued.\n",
                  "example" : null
                },
                "invoice_total" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Total amount of the invoice\n",
                  "minimum" : 0,
                  "example" : null
                },
                "invoice_status" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Current status of this invoice.\n\n* pending -\n  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`.\n  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.\n* voided - Indicates a voided invoice.\n* payment_due - Indicates the payment is not yet collected and is being retried as per retry settings.\n* 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* not_paid - Indicates the payment is not made and all attempts to collect is failed.\n",
                  "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.\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "cn_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Identifier for the credit-notes.\n",
                  "maxLength" : 50,
                  "example" : null
                },
                "applied_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "The transaction amount applied to this invoice\n",
                  "minimum" : 0,
                  "example" : null
                },
                "applied_at" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "Timestamp at which the transaction is applied.\n",
                  "example" : null
                },
                "cn_reason_code" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Credit note reason code. Deprecated use the cn_create_reason_code parameter instead\n\n* service_unsatisfactory - Service Unsatisfactory\n* other - Can be set when none of the above reason codes are applicable\n* subscription_cancellation - This reason will be set automatically for Credit Notes created during cancel subscription operation\n* fraudulent - FRAUDULENT\n* order_change - Order Change\n* subscription_pause - This reason will be automatically set to credit notes created during pause/resume subscription operation.\n* write_off -\n  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)\n  operation.\n* subscription_change -\n  This reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html)\n  is enabled\n* chargeback - Can be set when you are recording your customer Chargebacks\n* waiver - Waiver\n* order_cancellation - Order Cancellation\n* product_unsatisfactory - Product Unsatisfactory\n",
                  "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\n",
                  "maxLength" : 100,
                  "example" : null
                },
                "cn_date" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "The date this credit note is created.\n",
                  "example" : null
                },
                "cn_total" : {
                  "type" : "integer",
                  "format" : "int64",
                  "default" : 0,
                  "deprecated" : false,
                  "description" : "Total amount of the credit note\n",
                  "minimum" : 0,
                  "example" : null
                },
                "cn_status" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "The status of this Credit Note.\n\n* voided - When the Credit Note has been cancelled.\n* refund_due - When the credits are yet to be used, or have been partially used.\n* refunded - When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded).\n* adjusted - When the Credit Note has been adjusted against an invoice.\n",
                  "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.\n",
                  "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.\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "txn_id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Uniquely identifies the transaction.\n",
                  "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/v2/pcv-1/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/v2/pcv-1/transactions/transaction-object#status)\n  transaction to be reconciled at par with the gateway.  \n  [Learn more](https://www.chargebee.com/docs/payments/1.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.\n",
                  "example" : null
                },
                "txn_amount" : {
                  "type" : "integer",
                  "format" : "int64",
                  "deprecated" : false,
                  "description" : "Amount of this refund transaction.\n",
                  "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.\n",
            "items" : {
              "type" : "object",
              "deprecated" : false,
              "properties" : {
                "id" : {
                  "type" : "string",
                  "deprecated" : false,
                  "description" : "Uniquely identifies the transaction.\n",
                  "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/v2/pcv-1/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/v2/pcv-1/transactions/transaction-object#status)\n  transaction to be reconciled at par with the gateway.  \n  [Learn more](https://www.chargebee.com/docs/payments/1.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.\n",
                  "minimum" : 0,
                  "example" : null
                },
                "date" : {
                  "type" : "integer",
                  "format" : "unix-time",
                  "deprecated" : false,
                  "description" : "Indicates when this transaction occurred.\n",
                  "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)\n",
            "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\n",
                "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\n",
                "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\n",
                "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\n",
                "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\n",
                "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\n",
                "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\n",
                "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\n",
                "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\n",
                "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\n",
                "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\n",
                "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\n",
                "maxLength" : 100,
                "example" : null
              },
              "processor_error_message" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "This message describes the specific error that the payment processor encountered\n",
                "maxLength" : 65000,
                "example" : null
              },
              "error_cause_id" : {
                "type" : "string",
                "deprecated" : false,
                "description" : "A [Chargebee-defined code](/docs/api/errors)\nthat 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\n",
                "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.\n",
                "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)\n\nIf any invoice is to be created for a subscription all the unbilled charges associated with the subscription will be included in that invoice.\n\nIf any invoice is to be created for a customer, all the unbilled charges associated with its subscriptions will be included in that invoice.\n\nAny automatic invoice creation like renewal, activation, etc., will include the unbilled charges.\n\nSubscriptions 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'.\n\nIf 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.\n",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Uniquely identifies an unbilled charge.\n",
            "maxLength" : 40,
            "example" : null
          },
          "customer_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "A unique identifier for the customer being charged.\n",
            "maxLength" : 50,
            "example" : null
          },
          "subscription_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "A unique identifier for the subscription this charge belongs to.\n",
            "maxLength" : 50,
            "example" : null
          },
          "date_from" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Start date of this charge.\n",
            "example" : null
          },
          "date_to" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "End date of this charge.\n",
            "example" : null
          },
          "unit_amount" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Unit amount of the charge item.\n",
            "minimum" : 0,
            "example" : null
          },
          "pricing_model" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The pricing scheme for this line item.\n\n* tiered - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.\n* volume - The per unit price is based on the tier that the total quantity falls in.\n* per_unit - A fixed price per unit quantity.\n* flat_fee - A fixed price that is not quantity-based.\n* stairstep - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.\n",
            "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.\n",
            "minimum" : 0,
            "example" : null
          },
          "amount" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Total amount of this charge. Typically equals to unit amount x quantity.\n",
            "minimum" : 0,
            "example" : null
          },
          "currency_code" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The currency code (ISO 4217 format) for the charge.\n",
            "maxLength" : 3,
            "example" : null
          },
          "discount_amount" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Total discounts for this charge.\n",
            "minimum" : 0,
            "example" : null
          },
          "description" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Detailed description about this charge.\n",
            "maxLength" : 250,
            "example" : null
          },
          "entity_type" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Specifies the modelled entity this line item is based on.\n\n* plan_setup -\n  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)\n  id\n* plan -\n  Indicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)\n  id\n* adhoc - Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case\n* addon -\n  Indicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the [addon](/docs/api/v2/pcv-1/addons/addon-object)\n  id\n",
            "enum" : [ "plan_setup", "plan", "addon", "adhoc" ],
            "example" : null
          },
          "entity_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The identifier of the modelled entity this charge is based on. Will be null for 'adhoc' entity type.\n",
            "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.\n",
            "example" : null
          },
          "voided_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp indicating the date and time this charge got voided.\n",
            "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`\nx `quantity_in_decimal`.\nReturned when [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
            "maxLength" : 39,
            "example" : null
          },
          "quantity_in_decimal" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The decimal representation of the quantity of this entity. Returned when the entity is quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
            "maxLength" : 33,
            "example" : null
          },
          "amount_in_decimal" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The decimal representation of the unit amount for the entity. The value is in major units of the currency. Returned when the entity is quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
            "maxLength" : 39,
            "example" : null
          },
          "created_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp indicating when the unbilled charge was created.\n",
            "example" : null
          },
          "updated_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp indicating when the unbilled charge was last updated\n",
            "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.\n",
            "example" : null
          },
          "business_entity_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity.  \n**Note**\n\n[Multiple Business Entities](/docs/api/getting-started) is a feature available only on Product Catalog 2.0.\n",
            "maxLength" : 50,
            "example" : null
          },
          "deleted" : {
            "type" : "boolean",
            "deprecated" : false,
            "description" : "Indicates that this resource has been deleted.\n",
            "example" : null
          },
          "tiers" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "The list of tiers applicable for this line item\n",
            "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\n",
                  "minimum" : 0,
                  "example" : null
                },
                "ending_unit" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "description" : "The upper limit of a range of units for the tier\n",
                  "example" : null
                },
                "quantity_used" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "description" : "The number of units purchased in a range.\n",
                  "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`\npricing , or the price of each unit in the tier if the charge model is `tiered`\n/`volume`\npricing.\n",
                  "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`\nof the next lower tier. Returned only when the `line_items.pricing_model`\nis `tiered`\n, `volume`\nor `stairstep`\nand [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "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`\nof the next higher tier. Returned only when the `line_items.pricing_model`\nis `tiered`\n, `volume`\nor stairstep and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "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`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "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`\nis `tiered`\nor `volume`.\nWhen the `pricing_model`\nis `stairstep`\n, it is the decimal representation of the total price for `line_item`.\nThe value is in major units of the currency. Returned when the `line_item`\nis quantity-based and [multi-decimal pricing](/docs/api/v2/pcv-1/currencies)\nis enabled.\n",
                  "maxLength" : 40,
                  "example" : null
                },
                "pricing_type" : {
                  "type" : "string",
                  "deprecated" : false,
                  "enum" : [ "per_unit", "flat_fee", "package" ],
                  "example" : null
                },
                "package_size" : {
                  "type" : "integer",
                  "format" : "int32",
                  "deprecated" : false,
                  "minimum" : 1,
                  "example" : null
                }
              },
              "required" : [ "quantity_used", "starting_unit", "unit_amount" ],
              "example" : null
            },
            "example" : null
          }
        },
        "required" : [ "currency_code", "deleted", "entity_type", "is_voided", "updated_at" ],
        "example" : null
      },
      "UnbilledChargesCreatedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "unbilled_charges" : {
                "type" : "array",
                "items" : {
                  "$ref" : "#/components/schemas/UnbilledCharge"
                },
                "example" : null
              }
            },
            "required" : [ "unbilled_charges" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "UnbilledChargesDeletedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "unbilled_charges" : {
                "type" : "array",
                "items" : {
                  "$ref" : "#/components/schemas/UnbilledCharge"
                },
                "example" : null
              }
            },
            "required" : [ "unbilled_charges" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "UnbilledChargesHandling" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "no_action", "invoice" ],
        "example" : null
      },
      "UnbilledChargesInvoicedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "unbilled_charges" : {
                "type" : "array",
                "items" : {
                  "$ref" : "#/components/schemas/UnbilledCharge"
                },
                "example" : null
              },
              "invoice" : {
                "$ref" : "#/components/schemas/Invoice"
              }
            },
            "required" : [ "invoice", "unbilled_charges" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "UnbilledChargesMeta" : {
        "type" : "object",
        "properties" : {
          "count" : {
            "type" : "integer",
            "format" : "int32",
            "default" : 0,
            "deprecated" : false,
            "example" : null
          },
          "has_more" : {
            "type" : "boolean",
            "default" : false,
            "deprecated" : false,
            "example" : null
          }
        },
        "required" : [ "count", "has_more" ],
        "example" : null
      },
      "UnbilledChargesOption" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "invoice", "delete" ],
        "example" : null
      },
      "UnbilledChargesVoidedEvent" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "string",
            "description" : "The ID of the event",
            "example" : null
          },
          "occurred_at" : {
            "type" : "integer",
            "format" : "int64",
            "description" : "Timestamp of the event",
            "example" : null
          },
          "source" : {
            "type" : "string",
            "description" : "Source of the event",
            "example" : null
          },
          "object" : {
            "type" : "string",
            "description" : "The object of the event",
            "example" : null
          },
          "api_version" : {
            "type" : "string",
            "description" : "API version",
            "example" : null
          },
          "event_type" : {
            "type" : "string",
            "description" : "Type of the event",
            "example" : null
          },
          "webhook_status" : {
            "type" : "string",
            "description" : "Status of webhook",
            "example" : null
          },
          "content" : {
            "type" : "object",
            "properties" : {
              "unbilled_charges" : {
                "type" : "array",
                "items" : {
                  "$ref" : "#/components/schemas/UnbilledCharge"
                },
                "example" : null
              }
            },
            "required" : [ "unbilled_charges" ],
            "example" : null
          }
        },
        "required" : [ "api_version", "content", "event_type", "id", "object", "occurred_at", "source", "webhook_status" ],
        "example" : null
      },
      "UnpaidInvoicesHandling" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "no_action", "schedule_payment_collection" ],
        "example" : null
      },
      "UsageAccumulationResetFrequency" : {
        "type" : "string",
        "deprecated" : false,
        "enum" : [ "never", "subscription_billing_frequency" ],
        "example" : null
      },
      "ValidationStatus" : {
        "type" : "string",
        "default" : "not_validated",
        "deprecated" : false,
        "enum" : [ "not_validated", "valid", "partially_valid", "invalid" ],
        "example" : null
      },
      "ValueSchema" : {
        "type" : "object",
        "properties" : { },
        "example" : null
      },
      "VariantCriteria" : {
        "type" : "object",
        "properties" : { },
        "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 is a unique account number which is generated so you don't need to share your sensitive bank account details with your users. A virtual bank account can be paid with ACH credit or wire transfer. Users can make payment of the amount due to this account, and the amount will be matched with the invoice.\n",
        "properties" : {
          "id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Identifier of the virtual bank account\n",
            "maxLength" : 40,
            "example" : null
          },
          "customer_id" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Identifier of the customer.\n",
            "maxLength" : 50,
            "example" : null
          },
          "email" : {
            "type" : "string",
            "format" : "email",
            "deprecated" : false,
            "description" : "Email address associated with the virtual bank account\n",
            "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\n",
            "maxLength" : 100,
            "example" : null
          },
          "account_number" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The account number to which funds will be transferred.\n",
            "maxLength" : 50,
            "minLength" : 5,
            "example" : null
          },
          "routing_number" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The routing number of the bank\n",
            "maxLength" : 50,
            "minLength" : 3,
            "example" : null
          },
          "swift_code" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "Swift code of the bank in which the account exists.\n",
            "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 end-to-end 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.\n",
            "maxLength" : 50,
            "example" : null
          },
          "resource_version" : {
            "type" : "integer",
            "format" : "int64",
            "deprecated" : false,
            "description" : "Version number of this resource. The `resource_version`\nis 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.\n",
            "example" : null
          },
          "updated_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp indicating when this virtual bank account resource was last updated.\n",
            "example" : null
          },
          "created_at" : {
            "type" : "integer",
            "format" : "unix-time",
            "deprecated" : false,
            "description" : "Timestamp indicating when this virtual bank account resource is created.\n",
            "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).\n",
            "maxLength" : 150,
            "example" : null
          },
          "deleted" : {
            "type" : "boolean",
            "deprecated" : false,
            "description" : "Indicates that this resource has been deleted.\n",
            "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.\n",
            "maxLength" : 40,
            "example" : null
          },
          "name" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The name assigned to the webhook.\n",
            "maxLength" : 50,
            "example" : null
          },
          "url" : {
            "type" : "string",
            "deprecated" : false,
            "description" : "The full URL of the webhook endpoint.\n",
            "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.\n",
            "example" : null
          },
          "disabled" : {
            "type" : "boolean",
            "default" : false,
            "deprecated" : false,
            "description" : "Indicates whether the webhook endpoint is disabled. If `true`\n, the endpoint is disabled; if `false`\n, it is enabled.\n",
            "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.\n",
            "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.\n\n* v1 - If selected, the webhook payload includes only attributes from API v1 resources.\n* v2 - If selected, the webhook payload includes only attributes from API v2 resources.\n",
            "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**\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* 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* 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",
            "enum" : [ "plans_addons", "items", "compat" ],
            "example" : null
          },
          "enabled_events" : {
            "type" : "array",
            "deprecated" : false,
            "description" : "The types of events that trigger this webhook. For a complete list, see [event types](/docs/api/v2/pcv-1/webhook_endpoints)\n.\n",
            "items" : {
              "type" : "string",
              "deprecated" : false,
              "description" : "The types of events that trigger this webhook. For a complete list, see [event types](/docs/api/v2/pcv-1/webhook_endpoints)\n.\n\n* order_ready_to_ship - Triggered when an order reaches its shipping date\n* omnichannel_subscription_imported - Triggered when an omnichannel subscription is imported\n* payment_source_expiring - Sent when the customer's payment source is expiring soon. Sent 30 days before the expiry date.\n* omnichannel_subscription_item_grace_period_started - Triggered when an omnichannel subscription item's grace period has started\n* plan_updated - Sent when a plan is changed.\n* subscription_advance_invoice_schedule_removed - Triggered when scheduled advance invoice is removed for a subscription.\n* plan_deleted - Sent when a plan is deleted.\n* card_added - Sent when a card is added for a customer.\n* customer_moved_out - Sent when a customer is copied to another site\n* gift_updated - Triggered when a gift is updated\n* payment_source_expired - Sent when a payment source for a customer is expired\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* customer_deleted - Sent when a customer is deleted\n* plan_created - Sent when a plan is created.\n* customer_moved_in - Sent when a customer is copied from another site\n* payment_succeeded - Sent when the payment is successfully collected\n* order_ready_to_process - Triggered when an order reaches its order date\n* subscription_scheduled_changes_removed - Sent when scheduled change for the subscription is removed.\n* contract_term_renewed - Triggered when new contract term is renewed\n* payment_failed - Sent when an attempt to charge the customer's credit card fails\n* coupon_codes_deleted - Sent when coupon codes are deleted in coupon set\n* token_created - Sent when a Token is created\n* customer_changed - Sent when a customer is changed\n* subscription_scheduled_resumption_removed - Triggered when scheduled resumption is removed for the subscription.\n* card_expired - Sent when a card for a customer is expired\n* voucher_expired - Triggered when a payment voucher is expired\n* omnichannel_one_time_order_created - Triggered when an omnichannel one time order is created\n* addon_created - Sent when an addon is created.\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* omnichannel_subscription_item_expired - Triggered when an omnichannel subscription item is expired\n* hierarchy_created - Triggered when a hierarchy is created\n* order_cancelled - Triggered when an order is cancelled\n* addon_deleted - Sent when an addon is deleted.\n* unbilled_charges_invoiced - Triggered when unbilled charges are invoiced\n* omnichannel_subscription_item_renewed - Triggered when an omnichannel subscription item is renewed\n* authorization_succeeded - Triggered when an authorization transaction is created.\n* gift_claimed - Triggered when a gift is claimed\n* omnichannel_one_time_order_item_cancelled - Triggered when an omnichannel one time order item is cancelled\n* order_deleted - Triggered when an order is deleted\n* payment_initiated - Sent when a payment is initiated via direct debit\n* unbilled_charges_voided - Triggered when unbilled charges are voided\n* omnichannel_subscription_item_scheduled_change_removed - Triggered when an omnichannel subscription item scheduled change is removed\n* order_resent - Triggered when an order is resent\n* subscription_created_with_backdating - Sent when a new subscription is created with backdating.\n* subscription_reactivated - Sent when the subscription is moved from cancelled state to active or in_trial state\n* coupon_updated - Sent when a coupon is changed.\n* payment_source_locally_deleted - Sent when a payment source for a customer is removed from Chargebee\n* 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.\n* coupon_set_created - Sent when a coupon set is created\n* einvoice_created - Triggered when an e-invoice is created for an invoice or credit note.\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_paused - Sent when the subscription is paused.\n* token_expired - Sent when a Token is expired\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* omnichannel_subscription_item_reactivated - Triggered when an omnichannel subscription item is reactivated\n* subscription_activated_with_backdating - Sent after the subscription changes to `active` from another `status`, while the change is backdated.\n* invoice_deleted - Event triggered when an invoice is deleted.\n* omnichannel_subscription_created - Triggered when an omnichannel subscription is created\n* order_created - Triggered when an order is created\n* quote_deleted - Triggered when a quote is deleted\n* subscription_reactivated_with_backdating - Sent when the subscription is moved from cancelled state to active or in_trial state with past 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* unbilled_charges_deleted - Triggered when unbilled charges are deleted\n* subscription_moved_out - Triggered when a subscription is moved to another customer\n* subscription_shipping_address_updated - Triggered when shipping address is added or updated for a subscription.\n* token_consumed - Sent when a Token is consumed\n* transaction_deleted - Triggered when a transaction is deleted.\n* subscription_ramp_deleted - Triggered when a subscription ramp is deleted.\n* subscription_trial_extended - Trial Extension\n* coupon_codes_updated - Sent when coupon codes are updated\n* omnichannel_subscription_item_dunning_started - Triggered when an omnichannel subscription item's dunning has started\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* card_updated - Sent when the card is updated for a customer.\n* gift_unclaimed - Triggered when a new gift is unclaimed and is ready to be claimed\n* subscription_advance_invoice_schedule_added - Triggered when advance invoice is scheduled for a subscription.\n* subscription_trial_end_reminder - Sent when the customer's trial period is about to end.\n* hierarchy_deleted - Triggered when a hierarchy is deleted\n* subscription_changed - Sent after the subscription's recurring items have been changed\n* vault_token_updated - Triggered when a vaulted payment method is updated.\n* gift_scheduled - Triggered when a new gift is created\n* invoice_generated_with_backdating - Event triggered when a new invoice is generated with past date as invoice date.\n* payment_intent_updated - Sent when a payment intent is updated\n* virtual_bank_account_added - Sent when a virtual bank account is added for a customer.\n* subscription_movement_failed - Triggered when a subscription movement fails\n* tax_withheld_deleted - Triggered when a tax withheld is deleted\n* omnichannel_subscription_item_change_scheduled - Triggered when an omnichannel subscription item change is scheduled\n* pending_invoice_updated - Event triggered when the option \"Notify and wait to close invoices\" is enabled, and the 'Pending' invoice is updated.\n* promotional_credits_deducted - Sent when promotional credits are deducted for a customer\n* payment_refunded - Sent when a payment refund is made\n* subscription_ramp_created - Triggered when a subscription ramp is created.\n* omnichannel_subscription_item_cancellation_scheduled - Triggered when an omnichannel subscription item is scheduled for cancellation\n* subscription_started - Sent when a 'future' subscription gets started at the scheduled date.\n* credit_note_deleted - Sent when a credit note is deleted\n* payment_source_updated - Sent when the payment source is updated for a customer or when role is assigned to the payment source.\n* credit_note_updated - Sent when a credit note is updated\n* quote_created - Triggered when a quote is created\n* credit_note_created - Sent when a credit note is created\n* gift_expired - Triggered when a gift expires\n* transaction_created - Triggered when a transaction is recorded\n* contract_term_terminated - Triggered when contract term is terminated\n* payment_source_deleted - Sent when a payment source is deleted for a customer\n* contract_term_cancelled - Triggered when contract term is cancelled\n* sales_order_created - Triggered when a sales order is created\n* subscription_cancellation_reminder - Sent when the customer's subscription is nearing its scheduled cancellation date.\n* coupon_codes_added - Sent when coupon codes are added in coupon set\n* order_returned - Triggered when an order is marked as returned\n* rule_created - Triggered when a rule is created\n* subscription_activated - Sent after the subscription has been moved from trial to active state\n* omnichannel_subscription_item_resumed - Triggered when an omnichannel subscription item is resumed\n* subscription_renewal_reminder - Sent before each subscription's renewal based on plan's period\n* omnichannel_subscription_item_changed - Triggered when an omnichannel subscription item is changed\n* omnichannel_subscription_item_grace_period_expired - Triggered when an omnichannel subscription item's grace period has expired\n* subscription_ramp_updated - Triggered when a subscription ramp is updated.\n* promotional_credits_added - Sent when promotional credits are added for a customer\n* virtual_bank_account_deleted - Sent when a virtual bank account is deleted for a customer.\n* dunning_updated - Sent when dunning is paused for an invoice\n* subscription_changed_with_backdating - Sent after the subscription's recurring items have been changed with backdated date\n* rule_updated - Triggered when a rule is updated\n* mrr_updated - Sent when either of MRR or CMRR of a subscription changes\n* payment_source_added - Sent when a payment source is added for a customer.\n* subscription_ramp_applied - Triggered when a subscription ramp is applied.\n* card_deleted - Sent when a card is deleted for a customer\n* omnichannel_subscription_item_pause_scheduled - Triggered when an omnichannel subscription item is scheduled for pause\n* sales_order_updated - Triggered when a sales order is updated\n* subscription_cancellation_scheduled - Sent when subscription is scheduled to cancel at end of current term\n* subscription_deleted - Sent when a subscription has been deleted\n* subscription_moved_in - Triggered when a subscription is moved from another customer\n* record_purchase_failed - Triggered when an omnichannel record purchase fails\n* subscription_changes_scheduled - Sent when subscription changes are scheduled for later. Changes will be applied at the end of current term.\n* voucher_create_failed - Triggered when payment voucher creation fails\n* omnichannel_subscription_item_dunning_expired - Triggered when an omnichannel subscription item's dunning has expired\n* vault_token_deleted - Triggered when a vaulted payment method is deleted from the vault.\n* coupon_set_deleted - Sent when a coupon set is deleted\n* coupon_set_updated - Sent when a coupon set is changed\n* addon_updated - Sent when an addon is changed.\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* card_expiry_reminder - Sent when the customer's credit card is expiring soon. Sent 30 days before the expiry date.\n* coupon_created - Sent when a coupon is created.\n* subscription_resumption_scheduled - Triggered when the subscription resumption is scheduled.\n* omnichannel_subscription_item_upgraded - Triggered when an omnichannel subscription item is upgraded\n* order_updated - Triggered when an order is updated\n* vault_token_created - Triggered when a payment method is tokenized and stored in the vault.\n* omnichannel_subscription_item_resubscribed - Triggered when an omnichannel subscription item is resubscribed\n* refund_initiated - Sent when a refund is initiated via direct debit\n* omnichannel_subscription_item_downgraded - Triggered when an omnichannel subscription item is downgraded\n* einvoice_updated - Triggered when an e-invoice is updated (for example when its status or provider responses change).\n* gift_cancelled - Triggered when a gift is cancelled.\n* subscription_renewed - Sent when the subscription is renewed from the current term.\n* omnichannel_subscription_item_cancelled - Triggered when an omnichannel subscription item is cancelled\n* subscription_scheduled_pause_removed - Triggered when scheduled pause is removed for the subscription.\n* omnichannel_subscription_item_paused - Triggered when an omnichannel subscription item is paused\n* omnichannel_subscription_item_scheduled_cancellation_removed - Triggered when an omnichannel subscription item scheduled cancellation is removed\n* quote_updated - Triggered when a quote is 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* tax_withheld_refunded - Sent when a tax withheld refund is made\n* coupon_deleted - Sent when a coupon is deleted.\n* order_delivered - Triggered when an order is marked as delivered\n* subscription_pause_scheduled - Sent when the subscription is scheduled to pause.\n* subscription_advance_invoice_schedule_updated - Triggered when scheduled advance invoice is updated for a subscription.\n* voucher_created - Triggered when a payment voucher is created\n* credit_note_created_with_backdating - Sent when a credit note is created with past date as credit note date\n* unbilled_charges_created - Triggered when unbilled charges are created\n* subscription_ramp_drafted - Triggered when a subscription ramp is moved to draft status.\n* rule_deleted - Triggered when a rule is deleted\n* payment_intent_created - Sent when a payment intent is created\n* contract_term_created - Triggered when new contract term is created\n* contract_term_completed - Triggered when contract term is completed\n* tax_withheld_recorded - Triggered when a tax withheld is recorded for an invoice\n* subscription_resumed - Sent when the subscription is moved from paused state to active state\n* virtual_bank_account_updated - Sent when the virtual bank account is updated for a customer.\n* subscription_created - Sent when a new subscription is created.\n",
              "enum" : [ "plan_created", "plan_updated", "plan_deleted", "addon_created", "addon_updated", "addon_deleted", "coupon_created", "coupon_updated", "coupon_deleted", "coupon_set_created", "coupon_set_updated", "coupon_set_deleted", "coupon_codes_added", "coupon_codes_deleted", "coupon_codes_updated", "customer_created", "customer_changed", "customer_deleted", "customer_moved_out", "customer_moved_in", "promotional_credits_added", "promotional_credits_deducted", "subscription_created", "subscription_created_with_backdating", "subscription_started", "subscription_trial_end_reminder", "subscription_activated", "subscription_activated_with_backdating", "subscription_changed", "subscription_trial_extended", "mrr_updated", "subscription_changed_with_backdating", "subscription_cancellation_scheduled", "subscription_cancellation_reminder", "subscription_cancelled", "subscription_canceled_with_backdating", "subscription_reactivated", "subscription_reactivated_with_backdating", "subscription_renewed", "subscription_items_renewed", "subscription_scheduled_cancellation_removed", "subscription_changes_scheduled", "subscription_scheduled_changes_removed", "subscription_shipping_address_updated", "subscription_deleted", "subscription_paused", "subscription_pause_scheduled", "subscription_scheduled_pause_removed", "subscription_resumed", "subscription_resumption_scheduled", "subscription_scheduled_resumption_removed", "subscription_advance_invoice_schedule_added", "subscription_advance_invoice_schedule_updated", "subscription_advance_invoice_schedule_removed", "pending_invoice_created", "pending_invoice_updated", "invoice_generated", "invoice_generated_with_backdating", "invoice_updated", "invoice_deleted", "credit_note_created", "credit_note_created_with_backdating", "credit_note_updated", "credit_note_deleted", "einvoice_created", "einvoice_updated", "subscription_renewal_reminder", "transaction_created", "transaction_updated", "transaction_deleted", "payment_succeeded", "payment_failed", "dunning_updated", "payment_refunded", "payment_initiated", "refund_initiated", "authorization_succeeded", "authorization_voided", "card_added", "card_updated", "card_expiry_reminder", "card_expired", "card_deleted", "payment_source_added", "payment_source_updated", "payment_source_deleted", "payment_source_expiring", "payment_source_expired", "payment_source_locally_deleted", "virtual_bank_account_added", "virtual_bank_account_updated", "virtual_bank_account_deleted", "token_created", "token_consumed", "token_expired", "unbilled_charges_created", "unbilled_charges_voided", "unbilled_charges_deleted", "unbilled_charges_invoiced", "order_created", "order_updated", "order_cancelled", "order_delivered", "order_returned", "order_ready_to_process", "order_ready_to_ship", "order_deleted", "order_resent", "quote_created", "quote_updated", "quote_deleted", "tax_withheld_recorded", "tax_withheld_deleted", "tax_withheld_refunded", "gift_scheduled", "gift_unclaimed", "gift_claimed", "gift_expired", "gift_cancelled", "gift_updated", "hierarchy_created", "hierarchy_deleted", "payment_intent_created", "payment_intent_updated", "contract_term_created", "contract_term_renewed", "contract_term_terminated", "contract_term_completed", "contract_term_cancelled", "voucher_created", "voucher_expired", "voucher_create_failed", "subscription_ramp_created", "subscription_ramp_deleted", "subscription_ramp_applied", "subscription_ramp_drafted", "subscription_ramp_updated", "subscription_moved_in", "subscription_moved_out", "subscription_movement_failed", "omnichannel_subscription_created", "omnichannel_subscription_item_renewed", "omnichannel_subscription_item_downgraded", "omnichannel_subscription_item_expired", "omnichannel_subscription_item_cancellation_scheduled", "omnichannel_subscription_item_scheduled_cancellation_removed", "omnichannel_subscription_item_resubscribed", "omnichannel_subscription_item_upgraded", "omnichannel_subscription_item_cancelled", "omnichannel_subscription_imported", "omnichannel_subscription_item_grace_period_started", "omnichannel_subscription_item_grace_period_expired", "omnichannel_subscription_item_dunning_started", "omnichannel_subscription_item_dunning_expired", "rule_created", "rule_updated", "rule_deleted", "record_purchase_failed", "omnichannel_subscription_item_change_scheduled", "omnichannel_subscription_item_scheduled_change_removed", "omnichannel_subscription_item_reactivated", "sales_order_created", "sales_order_updated", "omnichannel_subscription_item_changed", "omnichannel_subscription_item_paused", "omnichannel_subscription_item_resumed", "omnichannel_one_time_order_created", "omnichannel_one_time_order_item_cancelled", "omnichannel_subscription_item_pause_scheduled", "vault_token_created", "vault_token_updated", "vault_token_deleted" ],
              "example" : null
            },
            "example" : null
          }
        },
        "required" : [ "api_version", "disabled", "id", "name", "primary_url", "url" ],
        "example" : null
      }
    },
    "parameters" : {
      "payment-voucher-id" : {
        "name" : "payment-voucher-id",
        "in" : "path",
        "required" : true,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string"
        }
      },
      "item-price-id" : {
        "name" : "item-price-id",
        "in" : "path",
        "required" : true,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string"
        }
      },
      "reason-code-id" : {
        "name" : "reason-code-id",
        "in" : "path",
        "required" : true,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string"
        }
      },
      "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"
        }
      },
      "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"
        }
      },
      "portal-session-id" : {
        "name" : "portal-session-id",
        "in" : "path",
        "required" : true,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string"
        }
      },
      "attached-item-id" : {
        "name" : "attached-item-id",
        "in" : "path",
        "required" : true,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string"
        }
      },
      "plan-id" : {
        "name" : "plan-id",
        "in" : "path",
        "required" : true,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string"
        }
      },
      "chargebee-request-origin-user-encoded" : {
        "name" : "chargebee-request-origin-user-encoded",
        "in" : "header",
        "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
        "required" : false,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string",
          "format" : "email",
          "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.",
          "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t"
        }
      },
      "meter-id" : {
        "name" : "meter-id",
        "in" : "path",
        "required" : true,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string"
        }
      },
      "business-entity-id" : {
        "name" : "business-entity-id",
        "in" : "path",
        "required" : true,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string"
        }
      },
      "item-id" : {
        "name" : "item-id",
        "in" : "path",
        "required" : true,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string"
        }
      },
      "subscription-entitlement-id" : {
        "name" : "subscription-entitlement-id",
        "in" : "path",
        "required" : true,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string"
        }
      },
      "customer-id" : {
        "name" : "customer-id",
        "in" : "path",
        "required" : true,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string"
        }
      },
      "cust-payment-source-id" : {
        "name" : "cust-payment-source-id",
        "in" : "path",
        "required" : true,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string"
        }
      },
      "site-currency-id" : {
        "name" : "site-currency-id",
        "in" : "path",
        "required" : true,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string"
        }
      },
      "chargebee-request-origin-device" : {
        "name" : "chargebee-request-origin-device",
        "in" : "header",
        "description" : "The device from which the customer has made the request",
        "required" : false,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string",
          "description" : "The device from which the customer has made the request",
          "example" : "Android"
        }
      },
      "thunking-plan-id" : {
        "name" : "thunking-plan-id",
        "in" : "path",
        "required" : true,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string"
        }
      },
      "tp-site-user-domain" : {
        "name" : "tp-site-user-domain",
        "in" : "path",
        "required" : true,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string"
        }
      },
      "event-id" : {
        "name" : "event-id",
        "in" : "path",
        "required" : true,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string"
        }
      },
      "async-response-id" : {
        "name" : "async-response-id",
        "in" : "path",
        "required" : true,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string"
        }
      },
      "site-owner-id" : {
        "name" : "site-owner-id",
        "in" : "path",
        "required" : true,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string"
        }
      },
      "rule-id" : {
        "name" : "rule-id",
        "in" : "path",
        "required" : true,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string"
        }
      },
      "time-machine-name" : {
        "name" : "time-machine-name",
        "in" : "path",
        "required" : true,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string"
        }
      },
      "item-family-id" : {
        "name" : "item-family-id",
        "in" : "path",
        "required" : true,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string"
        }
      },
      "product-id" : {
        "name" : "product-id",
        "in" : "path",
        "required" : true,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string"
        }
      },
      "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"
        }
      },
      "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"
        }
      },
      "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" ]
        }
      },
      "comment-id" : {
        "name" : "comment-id",
        "in" : "path",
        "required" : true,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string"
        }
      },
      "webhook-endpoint-id" : {
        "name" : "webhook-endpoint-id",
        "in" : "path",
        "required" : true,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string"
        }
      },
      "pc2-migration-item-id" : {
        "name" : "pc2-migration-item-id",
        "in" : "path",
        "required" : true,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string"
        }
      },
      "usage-file-id" : {
        "name" : "usage-file-id",
        "in" : "path",
        "required" : true,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string"
        }
      },
      "coupon-id" : {
        "name" : "coupon-id",
        "in" : "path",
        "required" : true,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string"
        }
      },
      "alert-id" : {
        "name" : "alert-id",
        "in" : "path",
        "required" : true,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string"
        }
      },
      "payment-intent-id" : {
        "name" : "payment-intent-id",
        "in" : "path",
        "required" : true,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string"
        }
      },
      "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"
        }
      },
      "chargebee-event-actions" : {
        "name" : "chargebee-event-actions",
        "in" : "header",
        "description" : "skip all actions to be done on the events",
        "required" : false,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string",
          "description" : "skip all actions to be done on the events",
          "enum" : [ "all-disabled" ]
        }
      },
      "pc2-migration-id" : {
        "name" : "pc2-migration-id",
        "in" : "path",
        "required" : true,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string"
        }
      },
      "async-api-request-id" : {
        "name" : "async-api-request-id",
        "in" : "path",
        "required" : true,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string"
        }
      },
      "chargebee-request-origin-user" : {
        "name" : "chargebee-request-origin-user",
        "in" : "header",
        "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
        "required" : false,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string",
          "format" : "email",
          "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.",
          "example" : "user@example.com"
        }
      },
      "custom-pricing-unit-id" : {
        "name" : "custom-pricing-unit-id",
        "in" : "path",
        "required" : true,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string"
        }
      },
      "export-id" : {
        "name" : "export-id",
        "in" : "path",
        "required" : true,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string"
        }
      },
      "gift-id" : {
        "name" : "gift-id",
        "in" : "path",
        "required" : true,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string"
        }
      },
      "unbilled-charge-id" : {
        "name" : "unbilled-charge-id",
        "in" : "path",
        "required" : true,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string"
        }
      },
      "addon-id" : {
        "name" : "addon-id",
        "in" : "path",
        "required" : true,
        "style" : "simple",
        "explode" : false,
        "schema" : {
          "type" : "string"
        }
      }
    },
    "securitySchemes" : {
      "BasicAuth" : {
        "type" : "http",
        "scheme" : "basic"
      }
    }
  },
  "jsonSchemaDialect" : "https://spec.openapis.org/oas/3.1/dialect/base",
  "webhooks" : {
    "subscription_pause_scheduled" : {
      "description" : "Triggered when the subscription is scheduled to pause.\n",
      "post" : {
        "summary" : "Triggered when the subscription is scheduled to pause.",
        "description" : "Triggered when the subscription is scheduled to pause.\n",
        "operationId" : "onSubscription_pause_scheduledWebhook",
        "requestBody" : {
          "description" : "Payload for subscription_pause_scheduled event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/SubscriptionPauseScheduledEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "netd_payment_due_reminder" : {
      "post" : {
        "summary" : "Sent when a invoice's due period is about to end",
        "operationId" : "onNetd_payment_due_reminderWebhook",
        "requestBody" : {
          "description" : "Payload for netd_payment_due_reminder event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/NetdPaymentDueReminderEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : true
      }
    },
    "order_delivered" : {
      "description" : "Triggered when an order is delivered.\n",
      "post" : {
        "summary" : "Triggered when an order is delivered.",
        "description" : "Triggered when an order is delivered.\n",
        "operationId" : "onOrder_deliveredWebhook",
        "requestBody" : {
          "description" : "Payload for order_delivered event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/OrderDeliveredEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "subscription_advance_invoice_schedule_added" : {
      "description" : "Triggered when advance invoice is scheduled for a subscription.\n",
      "post" : {
        "summary" : "Triggered when advance invoice is scheduled for a subscription.",
        "description" : "Triggered when advance invoice is scheduled for a subscription.\n",
        "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.\n",
      "post" : {
        "summary" : "Triggered when a gift expires.",
        "description" : "Triggered when a gift expires.\n",
        "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.\n",
      "post" : {
        "summary" : "Triggered when a tax withheld is deleted.",
        "description" : "Triggered when a tax withheld is deleted.\n",
        "operationId" : "onTax_withheld_deletedWebhook",
        "requestBody" : {
          "description" : "Payload for tax_withheld_deleted event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/TaxWithheldDeletedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "coupon_codes_added" : {
      "description" : "Triggered when coupon codes are added in coupon set.\n",
      "post" : {
        "summary" : "Triggered when coupon codes are added in coupon set.",
        "description" : "Triggered when coupon codes are added in coupon set.\n",
        "operationId" : "onCoupon_codes_addedWebhook",
        "requestBody" : {
          "description" : "Payload for coupon_codes_added event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/CouponCodesAddedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "unbilled_charges_deleted" : {
      "description" : "Triggered when unbilled charges are deleted\n",
      "post" : {
        "summary" : "Triggered when unbilled charges are deleted",
        "description" : "Triggered when unbilled charges are deleted\n",
        "operationId" : "onUnbilled_charges_deletedWebhook",
        "requestBody" : {
          "description" : "Payload for unbilled_charges_deleted event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/UnbilledChargesDeletedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "gift_cancelled" : {
      "description" : "Triggered when gift is cancelled.\n",
      "post" : {
        "summary" : "Triggered when gift is cancelled.",
        "description" : "Triggered when gift is cancelled.\n",
        "operationId" : "onGift_cancelledWebhook",
        "requestBody" : {
          "description" : "Payload for gift_cancelled event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/GiftCancelledEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "coupon_updated" : {
      "description" : "Triggered when a coupon is changed.\n",
      "post" : {
        "summary" : "Triggered when a coupon is changed.",
        "description" : "Triggered when a coupon is changed.\n",
        "operationId" : "onCoupon_updatedWebhook",
        "requestBody" : {
          "description" : "Payload for coupon_updated event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/CouponUpdatedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "order_cancelled" : {
      "description" : "Triggered when an order is cancelled.\n",
      "post" : {
        "summary" : "Triggered when an order is cancelled.",
        "description" : "Triggered when an order is cancelled.\n",
        "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.\n",
      "post" : {
        "summary" : "Triggered when a coupon is deleted.",
        "description" : "Triggered when a coupon is deleted.\n",
        "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.\n",
      "post" : {
        "summary" : "Triggered when scheduled change for the subscription is removed.",
        "description" : "Triggered when scheduled change for the subscription is removed.\n",
        "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.\n",
      "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.\n",
        "operationId" : "onPending_invoice_createdWebhook",
        "requestBody" : {
          "description" : "Payload for pending_invoice_created event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/PendingInvoiceCreatedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "unbilled_charges_created" : {
      "description" : "Triggered when unbilled charges are created\n",
      "post" : {
        "summary" : "Triggered when unbilled charges are created",
        "description" : "Triggered when unbilled charges are created\n",
        "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.\n",
      "post" : {
        "summary" : "Triggered when the subscription is resumed.",
        "description" : "Triggered when the subscription is resumed.\n",
        "operationId" : "onSubscription_resumedWebhook",
        "requestBody" : {
          "description" : "Payload for subscription_resumed event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/SubscriptionResumedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "subscription_cancelled" : {
      "description" : "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'.\n",
      "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'.\n",
        "operationId" : "onSubscription_cancelledWebhook",
        "requestBody" : {
          "description" : "Payload for subscription_cancelled event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/SubscriptionCancelledEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "payment_source_deleted" : {
      "description" : "Triggered when a payment source is deleted.\n",
      "post" : {
        "summary" : "Triggered when a payment source is deleted.",
        "description" : "Triggered when a payment source is deleted.\n",
        "operationId" : "onPayment_source_deletedWebhook",
        "requestBody" : {
          "description" : "Payload for payment_source_deleted event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/PaymentSourceDeletedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "quote_deleted" : {
      "description" : "Event triggered when a new quote is deleted.\n",
      "post" : {
        "summary" : "Event triggered when a new quote is deleted.",
        "description" : "Event triggered when a new quote is deleted.\n",
        "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.\n",
      "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.\n",
        "operationId" : "onInvoice_updatedWebhook",
        "requestBody" : {
          "description" : "Payload for invoice_updated event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/InvoiceUpdatedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "coupon_set_updated" : {
      "description" : "Triggered when a coupon set is updated.\n",
      "post" : {
        "summary" : "Triggered when a coupon set is updated.",
        "description" : "Triggered when a coupon set is updated.\n",
        "operationId" : "onCoupon_set_updatedWebhook",
        "requestBody" : {
          "description" : "Payload for coupon_set_updated event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/CouponSetUpdatedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "subscription_advance_invoice_schedule_removed" : {
      "description" : "Triggered when scheduled advance invoice is removed for a subscription.\n",
      "post" : {
        "summary" : "Triggered when scheduled advance invoice is removed for a subscription.",
        "description" : "Triggered when scheduled advance invoice is removed for a subscription.\n",
        "operationId" : "onSubscription_advance_invoice_schedule_removedWebhook",
        "requestBody" : {
          "description" : "Payload for subscription_advance_invoice_schedule_removed event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/SubscriptionAdvanceInvoiceScheduleRemovedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "subscription_activated_with_backdating" : {
      "description" : "Triggered after the subscription changes to `active` from another `status`, while the change is backdated.\n",
      "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.\n",
        "operationId" : "onSubscription_activated_with_backdatingWebhook",
        "requestBody" : {
          "description" : "Payload for subscription_activated_with_backdating event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/SubscriptionActivatedWithBackdatingEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "card_deleted" : {
      "description" : "Triggered when a card is deleted for a customer.\n",
      "post" : {
        "summary" : "Triggered when a card is deleted for a customer.",
        "description" : "Triggered when a card is deleted for a customer.\n",
        "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.\n",
      "post" : {
        "summary" : "Triggered when an order reaches it's shipping date.",
        "description" : "Triggered when an order reaches it's shipping date.\n",
        "operationId" : "onOrder_ready_to_shipWebhook",
        "requestBody" : {
          "description" : "Payload for order_ready_to_ship event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/OrderReadyToShipEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "subscription_trial_end_reminder" : {
      "description" : "Triggered 6 days prior to the trial period's end date.\n",
      "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.\n",
        "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.\n",
      "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.\n",
        "operationId" : "onSubscription_shipping_address_updatedWebhook",
        "requestBody" : {
          "description" : "Payload for subscription_shipping_address_updated event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/SubscriptionShippingAddressUpdatedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "subscription_moved_out" : {
      "post" : {
        "summary" : "Triggered when a subscription moved to other customer",
        "operationId" : "onSubscription_moved_outWebhook",
        "requestBody" : {
          "description" : "Payload for subscription_moved_out event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/SubscriptionMovedOutEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "voucher_create_failed" : {
      "description" : "Triggered when the Payment voucher Creation fails.\n",
      "post" : {
        "summary" : "Triggered when the Payment voucher Creation fails.",
        "description" : "Triggered when the Payment voucher Creation fails.\n",
        "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.\n",
      "post" : {
        "summary" : "Triggered when a gift is claimed.",
        "description" : "Triggered when a gift is claimed.\n",
        "operationId" : "onGift_claimedWebhook",
        "requestBody" : {
          "description" : "Payload for gift_claimed event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/GiftClaimedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "subscription_scheduled_resumption_removed" : {
      "description" : "Triggered when scheduled resumption is removed for the subscription.\n",
      "post" : {
        "summary" : "Triggered when scheduled resumption is removed for the subscription.",
        "description" : "Triggered when scheduled resumption is removed for the subscription.\n",
        "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 via direct debit.\n",
      "post" : {
        "summary" : "Triggered when a payment is initiated via direct debit.",
        "description" : "Triggered when a payment is initiated via direct debit.\n",
        "operationId" : "onPayment_initiatedWebhook",
        "requestBody" : {
          "description" : "Payload for payment_initiated event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/PaymentInitiatedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "subscription_reactivated_with_backdating" : {
      "description" : "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.\n",
      "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.\n",
        "operationId" : "onSubscription_reactivated_with_backdatingWebhook",
        "requestBody" : {
          "description" : "Payload for subscription_reactivated_with_backdating event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/SubscriptionReactivatedWithBackdatingEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "customer_deleted" : {
      "description" : "Triggered when a customer is deleted.\n",
      "post" : {
        "summary" : "Triggered when a customer is deleted.",
        "description" : "Triggered when a customer is deleted.\n",
        "operationId" : "onCustomer_deletedWebhook",
        "requestBody" : {
          "description" : "Payload for customer_deleted event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/CustomerDeletedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "token_expired" : {
      "description" : "Triggered when a nonce is expired.\n",
      "post" : {
        "summary" : "Triggered when a nonce is expired.",
        "description" : "Triggered when a nonce is expired.\n",
        "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.\n",
      "post" : {
        "summary" : "Triggered when a card is added for a customer.",
        "description" : "Triggered when a card is added for a customer.\n",
        "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.\n",
      "post" : {
        "summary" : "Triggered when a coupon is created.",
        "description" : "Triggered when a coupon is created.\n",
        "operationId" : "onCoupon_createdWebhook",
        "requestBody" : {
          "description" : "Payload for coupon_created event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/CouponCreatedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "refund_initiated" : {
      "description" : "Triggered when a refund is initiated via direct debit.\n",
      "post" : {
        "summary" : "Triggered when a refund is initiated via direct debit.",
        "description" : "Triggered when a refund is initiated via direct debit.\n",
        "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.\n",
      "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.\n",
        "operationId" : "onInvoice_generated_with_backdatingWebhook",
        "requestBody" : {
          "description" : "Payload for invoice_generated_with_backdating event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/InvoiceGeneratedWithBackdatingEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "rule_deleted" : {
      "post" : {
        "summary" : "Triggered when a rule is deleted",
        "operationId" : "onRule_deletedWebhook",
        "requestBody" : {
          "description" : "Payload for rule_deleted event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/RuleDeletedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "virtual_bank_account_deleted" : {
      "description" : "Triggered when a virtual bank account is deleted.\n",
      "post" : {
        "summary" : "Triggered when a virtual bank account is deleted.",
        "description" : "Triggered when a virtual bank account is deleted.\n",
        "operationId" : "onVirtual_bank_account_deletedWebhook",
        "requestBody" : {
          "description" : "Payload for virtual_bank_account_deleted event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/VirtualBankAccountDeletedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "subscription_created" : {
      "description" : "Triggered when a new subscription is created.\n",
      "post" : {
        "summary" : "Triggered when a new subscription is created.",
        "description" : "Triggered when a new subscription is created.\n",
        "operationId" : "onSubscription_createdWebhook",
        "requestBody" : {
          "description" : "Payload for subscription_created event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/SubscriptionCreatedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "voucher_created" : {
      "description" : "Triggered when a Payment voucher is created.\n",
      "post" : {
        "summary" : "Triggered when a Payment voucher is created.",
        "description" : "Triggered when a Payment voucher is created.\n",
        "operationId" : "onVoucher_createdWebhook",
        "requestBody" : {
          "description" : "Payload for voucher_created event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/VoucherCreatedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "rule_updated" : {
      "post" : {
        "summary" : "Triggered when a rule is updated",
        "operationId" : "onRule_updatedWebhook",
        "requestBody" : {
          "description" : "Payload for rule_updated event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/RuleUpdatedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "payment_source_locally_deleted" : {
      "description" : "Triggered when a payment source is deleted at Chargebee.\n",
      "post" : {
        "summary" : "Triggered when a payment source is deleted at Chargebee.",
        "description" : "Triggered when a payment source is deleted at Chargebee.\n",
        "operationId" : "onPayment_source_locally_deletedWebhook",
        "requestBody" : {
          "description" : "Payload for payment_source_locally_deleted event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/PaymentSourceLocallyDeletedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "order_returned" : {
      "description" : "Triggered when an order is returned.\n",
      "post" : {
        "summary" : "Triggered when an order is returned.",
        "description" : "Triggered when an order is returned.\n",
        "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.\n",
      "post" : {
        "summary" : "Triggered when a subscription is deleted.",
        "description" : "Triggered when a subscription is deleted.\n",
        "operationId" : "onSubscription_deletedWebhook",
        "requestBody" : {
          "description" : "Payload for subscription_deleted event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/SubscriptionDeletedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "invoice_generated" : {
      "description" : "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.\n",
      "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.\n",
        "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.\n",
      "post" : {
        "summary" : "Triggered when a Payment voucher is Expired.",
        "description" : "Triggered when a Payment voucher is Expired.\n",
        "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.\n",
      "post" : {
        "summary" : "Triggered when a authorization transaction is created.",
        "description" : "Triggered when a authorization transaction is created.\n",
        "operationId" : "onAuthorization_succeededWebhook",
        "requestBody" : {
          "description" : "Payload for authorization_succeeded event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/AuthorizationSucceededEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "payment_source_added" : {
      "description" : "Triggered when a payment source is added.\n",
      "post" : {
        "summary" : "Triggered when a payment source is added.",
        "description" : "Triggered when a payment source is added.\n",
        "operationId" : "onPayment_source_addedWebhook",
        "requestBody" : {
          "description" : "Payload for payment_source_added event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/PaymentSourceAddedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "gift_scheduled" : {
      "description" : "Triggered when a new gift is created.\n",
      "post" : {
        "summary" : "Triggered when a new gift is created.",
        "description" : "Triggered when a new gift is created.\n",
        "operationId" : "onGift_scheduledWebhook",
        "requestBody" : {
          "description" : "Payload for gift_scheduled event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/GiftScheduledEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "subscription_moved_in" : {
      "post" : {
        "summary" : "Triggered when a subscription moved from other customer",
        "operationId" : "onSubscription_moved_inWebhook",
        "requestBody" : {
          "description" : "Payload for subscription_moved_in event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/SubscriptionMovedInEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "subscription_changes_scheduled" : {
      "description" : "Triggered when subscription changes are scheduled for later. Changes will be applied at the end of current term.\n",
      "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.\n",
        "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.\n",
      "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.\n",
        "operationId" : "onSubscription_changed_with_backdatingWebhook",
        "requestBody" : {
          "description" : "Payload for subscription_changed_with_backdating event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/SubscriptionChangedWithBackdatingEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "subscription_scheduled_cancellation_removed" : {
      "description" : "Triggered when scheduled cancellation is removed for the subscription.\n",
      "post" : {
        "summary" : "Triggered when scheduled cancellation is removed for the subscription.",
        "description" : "Triggered when scheduled cancellation is removed for the subscription.\n",
        "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.\n",
      "post" : {
        "summary" : "Triggered when a payment refund is made.",
        "description" : "Triggered when a payment refund is made.\n",
        "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
      }
    },
    "gift_unclaimed" : {
      "description" : "Triggered when a new gift is unclaimed and is ready to be claimed.\n",
      "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.\n",
        "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.\n",
      "post" : {
        "summary" : "Triggered when a virtual bank account is added.",
        "description" : "Triggered when a virtual bank account is added.\n",
        "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.\n",
      "post" : {
        "summary" : "Triggered when a payment intent is created.",
        "description" : "Triggered when a payment intent is created.\n",
        "operationId" : "onPayment_intent_createdWebhook",
        "requestBody" : {
          "description" : "Payload for payment_intent_created event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/PaymentIntentCreatedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "transaction_created" : {
      "description" : "Triggered when a transaction is recorded.\n",
      "post" : {
        "summary" : "Triggered when a transaction is recorded.",
        "description" : "Triggered when a transaction is recorded.\n",
        "operationId" : "onTransaction_createdWebhook",
        "requestBody" : {
          "description" : "Payload for transaction_created event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/TransactionCreatedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "credit_note_created_with_backdating" : {
      "description" : "Triggered when a credit note is created such that generated_at is a value in the past.\n",
      "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.\n",
        "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.\n",
      "post" : {
        "summary" : "Triggered when contract term is terminated.",
        "description" : "Triggered when contract term is terminated.\n",
        "operationId" : "onContract_term_terminatedWebhook",
        "requestBody" : {
          "description" : "Payload for contract_term_terminated event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/ContractTermTerminatedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "order_created" : {
      "description" : "Triggered when an order is generated.\n",
      "post" : {
        "summary" : "Triggered when an order is generated.",
        "description" : "Triggered when an order is generated.\n",
        "operationId" : "onOrder_createdWebhook",
        "requestBody" : {
          "description" : "Payload for order_created event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/OrderCreatedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "payment_succeeded" : {
      "description" : "Triggered when the payment is successfully collected.\n",
      "post" : {
        "summary" : "Triggered when the payment is successfully collected.",
        "description" : "Triggered when the payment is successfully collected.\n",
        "operationId" : "onPayment_succeededWebhook",
        "requestBody" : {
          "description" : "Payload for payment_succeeded event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/PaymentSucceededEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "plan_deleted" : {
      "description" : "Triggered when a plan is deleted.\n",
      "post" : {
        "summary" : "Triggered when a plan is deleted.",
        "description" : "Triggered when a plan is deleted.\n",
        "operationId" : "onPlan_deletedWebhook",
        "requestBody" : {
          "description" : "Payload for plan_deleted event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/PlanDeletedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "subscription_canceled_with_backdating" : {
      "description" : "Triggered when a subscription is canceled with cancel_at set to a value in the past.\n",
      "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.\n",
        "operationId" : "onSubscription_canceled_with_backdatingWebhook",
        "requestBody" : {
          "description" : "Payload for subscription_canceled_with_backdating event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/SubscriptionCanceledWithBackdatingEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "subscription_movement_failed" : {
      "post" : {
        "summary" : "Triggered when a subscription movement failed",
        "operationId" : "onSubscription_movement_failedWebhook",
        "requestBody" : {
          "description" : "Payload for subscription_movement_failed event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/SubscriptionMovementFailedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "unbilled_charges_voided" : {
      "description" : "Triggered when unbilled charges are voided\n",
      "post" : {
        "summary" : "Triggered when unbilled charges are voided",
        "description" : "Triggered when unbilled charges are voided\n",
        "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.\n",
      "post" : {
        "summary" : "Event triggered when a new quote is generated.",
        "description" : "Event triggered when a new quote is generated.\n",
        "operationId" : "onQuote_createdWebhook",
        "requestBody" : {
          "description" : "Payload for quote_created event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/QuoteCreatedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "customer_moved_in" : {
      "description" : "Triggered when a customer is copied from another site.\n",
      "post" : {
        "summary" : "Triggered when a customer is copied from another site.",
        "description" : "Triggered when a customer is copied from another site.\n",
        "operationId" : "onCustomer_moved_inWebhook",
        "requestBody" : {
          "description" : "Payload for customer_moved_in event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/CustomerMovedInEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "coupon_set_deleted" : {
      "description" : "Triggered when a coupon set is deleted.\n",
      "post" : {
        "summary" : "Triggered when a coupon set is deleted.",
        "description" : "Triggered when a coupon set is deleted.\n",
        "operationId" : "onCoupon_set_deletedWebhook",
        "requestBody" : {
          "description" : "Payload for coupon_set_deleted event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/CouponSetDeletedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "subscription_advance_invoice_schedule_updated" : {
      "description" : "Triggered when scheduled advance invoice is updated for a subscription.\n",
      "post" : {
        "summary" : "Triggered when scheduled advance invoice is updated for a subscription.",
        "description" : "Triggered when scheduled advance invoice is updated for a subscription.\n",
        "operationId" : "onSubscription_advance_invoice_schedule_updatedWebhook",
        "requestBody" : {
          "description" : "Payload for subscription_advance_invoice_schedule_updated event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/SubscriptionAdvanceInvoiceScheduleUpdatedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "customer_changed" : {
      "description" : "Triggered when a customer is changed.\n",
      "post" : {
        "summary" : "Triggered when a customer is changed.",
        "description" : "Triggered when a customer is changed.\n",
        "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.\n",
      "post" : {
        "summary" : "Triggered when a 'future' subscription gets started.",
        "description" : "Triggered when a 'future' subscription gets started.\n",
        "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.\n",
      "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.\n",
        "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.\n",
      "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.\n",
        "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`.\n",
      "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`.\n",
        "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.\n",
      "post" : {
        "summary" : "Triggered when an order is updated.",
        "description" : "Triggered when an order is updated.\n",
        "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.\n",
      "post" : {
        "summary" : "Triggered when scheduled pause is removed for the subscription.",
        "description" : "Triggered when scheduled pause is removed for the subscription.\n",
        "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
      }
    },
    "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
      }
    },
    "subscription_cancellation_reminder" : {
      "description" : "Triggered 6 days prior to the scheduled cancellation date.\n",
      "post" : {
        "summary" : "Triggered 6 days prior to the scheduled cancellation date.",
        "description" : "Triggered 6 days prior to the scheduled cancellation date.\n",
        "operationId" : "onSubscription_cancellation_reminderWebhook",
        "requestBody" : {
          "description" : "Payload for subscription_cancellation_reminder event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/SubscriptionCancellationReminderEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "dunning_updated" : {
      "post" : {
        "summary" : "Triggered when dunning is paused for an invoice",
        "operationId" : "onDunning_updatedWebhook",
        "requestBody" : {
          "description" : "Payload for dunning_updated event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/DunningUpdatedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "addon_deleted" : {
      "description" : "Triggered when an addon is deleted.\n",
      "post" : {
        "summary" : "Triggered when an addon is deleted.",
        "description" : "Triggered when an addon is deleted.\n",
        "operationId" : "onAddon_deletedWebhook",
        "requestBody" : {
          "description" : "Payload for addon_deleted event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/AddonDeletedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "einvoice_created" : {
      "description" : "Triggered when an e-invoice is created for an invoice or credit note.\n",
      "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.\n",
        "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
      }
    },
    "subscription_created_with_backdating" : {
      "description" : "Triggered when a subscription is created and the value of subscription.started_at is in the past.\n",
      "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.\n",
        "operationId" : "onSubscription_created_with_backdatingWebhook",
        "requestBody" : {
          "description" : "Payload for subscription_created_with_backdating event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/SubscriptionCreatedWithBackdatingEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "order_deleted" : {
      "description" : "Triggered when an order is deleted.\n",
      "post" : {
        "summary" : "Triggered when an order is deleted.",
        "description" : "Triggered when an order is deleted.\n",
        "operationId" : "onOrder_deletedWebhook",
        "requestBody" : {
          "description" : "Payload for order_deleted event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/OrderDeletedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "token_consumed" : {
      "description" : "Triggered when a nonce is consumed.\n",
      "post" : {
        "summary" : "Triggered when a nonce is consumed.",
        "description" : "Triggered when a nonce is consumed.\n",
        "operationId" : "onToken_consumedWebhook",
        "requestBody" : {
          "description" : "Payload for token_consumed event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/TokenConsumedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "addon_updated" : {
      "description" : "Triggered when an addon is changed.\n",
      "post" : {
        "summary" : "Triggered when an addon is changed.",
        "description" : "Triggered when an addon is changed.\n",
        "operationId" : "onAddon_updatedWebhook",
        "requestBody" : {
          "description" : "Payload for addon_updated event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/AddonUpdatedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "hierarchy_deleted" : {
      "description" : "Triggered when a hierarchy is deleted.\n",
      "post" : {
        "summary" : "Triggered when a hierarchy is deleted.",
        "description" : "Triggered when a hierarchy is deleted.\n",
        "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.\n",
      "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.\n",
        "operationId" : "onSubscription_cancellation_scheduledWebhook",
        "requestBody" : {
          "description" : "Payload for subscription_cancellation_scheduled event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/SubscriptionCancellationScheduledEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "gift_updated" : {
      "description" : "Triggered when a gift is updated.\n",
      "post" : {
        "summary" : "Triggered when a gift is updated.",
        "description" : "Triggered when a gift is updated.\n",
        "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\n",
      "post" : {
        "summary" : "Trial Extension",
        "description" : "Trial Extension\n",
        "operationId" : "onSubscription_trial_extendedWebhook",
        "requestBody" : {
          "description" : "Payload for subscription_trial_extended event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/SubscriptionTrialExtendedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "subscription_renewed" : {
      "description" : "Triggered when the subscription is renewed from the current term.\n",
      "post" : {
        "summary" : "Triggered when the subscription is renewed from the current term.",
        "description" : "Triggered when the subscription is renewed from the current term.\n",
        "operationId" : "onSubscription_renewedWebhook",
        "requestBody" : {
          "description" : "Payload for subscription_renewed event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/SubscriptionRenewedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "addon_created" : {
      "description" : "Triggered when an addon is created.\n",
      "post" : {
        "summary" : "Triggered when an addon is created.",
        "description" : "Triggered when an addon is created.\n",
        "operationId" : "onAddon_createdWebhook",
        "requestBody" : {
          "description" : "Payload for addon_created event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/AddonCreatedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "card_expiry_reminder" : {
      "description" : "Triggered when the customer's credit card is expiring soon. Triggered 30 days before the expiry date.\n",
      "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.\n",
        "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.\n",
      "post" : {
        "summary" : "Triggered when a nonce is created.",
        "description" : "Triggered when a nonce is created.\n",
        "operationId" : "onToken_createdWebhook",
        "requestBody" : {
          "description" : "Payload for token_created event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/TokenCreatedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "plan_created" : {
      "description" : "Triggered when a plan is created.\n",
      "post" : {
        "summary" : "Triggered when a plan is created.",
        "description" : "Triggered when a plan is created.\n",
        "operationId" : "onPlan_createdWebhook",
        "requestBody" : {
          "description" : "Payload for plan_created event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/PlanCreatedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "plan_updated" : {
      "description" : "Triggered when a plan is changed.\n",
      "post" : {
        "summary" : "Triggered when a plan is changed.",
        "description" : "Triggered when a plan is changed.\n",
        "operationId" : "onPlan_updatedWebhook",
        "requestBody" : {
          "description" : "Payload for plan_updated event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/PlanUpdatedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "promotional_credits_added" : {
      "description" : "Triggered when promotional credit is added.\n",
      "post" : {
        "summary" : "Triggered when promotional credit is added.",
        "description" : "Triggered when promotional credit is added.\n",
        "operationId" : "onPromotional_credits_addedWebhook",
        "requestBody" : {
          "description" : "Payload for promotional_credits_added event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/PromotionalCreditsAddedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "subscription_resumption_scheduled" : {
      "description" : "Triggered when the subscription is scheduled to resume.\n",
      "post" : {
        "summary" : "Triggered when the subscription is scheduled to resume.",
        "description" : "Triggered when the subscription is scheduled to resume.\n",
        "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
      }
    },
    "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
      }
    },
    "coupon_codes_deleted" : {
      "description" : "Triggered when coupon codes are deleted in coupon set.\n",
      "post" : {
        "summary" : "Triggered when coupon codes are deleted in coupon set.",
        "description" : "Triggered when coupon codes are deleted in coupon set.\n",
        "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.\n",
      "post" : {
        "summary" : "Triggered when the card for a customer has expired.",
        "description" : "Triggered when the card for a customer has expired.\n",
        "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.\n",
      "post" : {
        "summary" : "Triggered when a credit note is updated.",
        "description" : "Triggered when a credit note is updated.\n",
        "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
      }
    },
    "einvoice_updated" : {
      "description" : "Triggered when an e-invoice is updated (for example when its status or provider responses change).\n",
      "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).\n",
        "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
      }
    },
    "promotional_credits_deducted" : {
      "description" : "Triggered when promotional credit is deducted.\n",
      "post" : {
        "summary" : "Triggered when promotional credit is deducted.",
        "description" : "Triggered when promotional credit is deducted.\n",
        "operationId" : "onPromotional_credits_deductedWebhook",
        "requestBody" : {
          "description" : "Payload for promotional_credits_deducted event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/PromotionalCreditsDeductedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "payment_source_expired" : {
      "description" : "Triggered when the payment source for a customer has expired.\n",
      "post" : {
        "summary" : "Triggered when the payment source for a customer has expired.",
        "description" : "Triggered when the payment source for a customer has expired.\n",
        "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.\n",
      "post" : {
        "summary" : "Triggered when a customer is copied to another site.",
        "description" : "Triggered when a customer is copied to another site.\n",
        "operationId" : "onCustomer_moved_outWebhook",
        "requestBody" : {
          "description" : "Payload for customer_moved_out event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/CustomerMovedOutEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "subscription_paused" : {
      "description" : "Triggered when the subscription is paused.\n",
      "post" : {
        "summary" : "Triggered when the subscription is paused.",
        "description" : "Triggered when the subscription is paused.\n",
        "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.\n",
      "post" : {
        "summary" : "Triggered when an order reaches it's order date.",
        "description" : "Triggered when an order reaches it's order date.\n",
        "operationId" : "onOrder_ready_to_processWebhook",
        "requestBody" : {
          "description" : "Payload for order_ready_to_process event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/OrderReadyToProcessEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "hierarchy_created" : {
      "description" : "Triggered when a hierarchy is created.\n",
      "post" : {
        "summary" : "Triggered when a hierarchy is created.",
        "description" : "Triggered when a hierarchy is created.\n",
        "operationId" : "onHierarchy_createdWebhook",
        "requestBody" : {
          "description" : "Payload for hierarchy_created event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/HierarchyCreatedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "transaction_deleted" : {
      "description" : "Triggered when a transaction is deleted.\n",
      "post" : {
        "summary" : "Triggered when a transaction is deleted.",
        "description" : "Triggered when a transaction is deleted.\n",
        "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.\n",
      "post" : {
        "summary" : "Triggered when a credit note is created.",
        "description" : "Triggered when a credit note is created.\n",
        "operationId" : "onCredit_note_createdWebhook",
        "requestBody" : {
          "description" : "Payload for credit_note_created event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/CreditNoteCreatedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "coupon_set_created" : {
      "description" : "Triggered when a coupon set is created.\n",
      "post" : {
        "summary" : "Triggered when a coupon set is created.",
        "description" : "Triggered when a coupon set is created.\n",
        "operationId" : "onCoupon_set_createdWebhook",
        "requestBody" : {
          "description" : "Payload for coupon_set_created event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/CouponSetCreatedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "transaction_updated" : {
      "description" : "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",
      "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.\n",
        "operationId" : "onTransaction_updatedWebhook",
        "requestBody" : {
          "description" : "Payload for transaction_updated event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/TransactionUpdatedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "payment_intent_updated" : {
      "description" : "Triggered when a payment intent is updated.\n",
      "post" : {
        "summary" : "Triggered when a payment intent is updated.",
        "description" : "Triggered when a payment intent is updated.\n",
        "operationId" : "onPayment_intent_updatedWebhook",
        "requestBody" : {
          "description" : "Payload for payment_intent_updated event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/PaymentIntentUpdatedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "mrr_updated" : {
      "description" : "Triggered when either of MRR or CMRR is changed.\n",
      "post" : {
        "summary" : "Triggered when either of MRR or CMRR is changed.",
        "description" : "Triggered when either of MRR or CMRR is changed.\n",
        "operationId" : "onMrr_updatedWebhook",
        "requestBody" : {
          "description" : "Payload for mrr_updated event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/MrrUpdatedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "order_resent" : {
      "description" : "Triggered when an order is resent.\n",
      "post" : {
        "summary" : "Triggered when an order is resent.",
        "description" : "Triggered when an order is resent.\n",
        "operationId" : "onOrder_resentWebhook",
        "requestBody" : {
          "description" : "Payload for order_resent event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/OrderResentEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "unbilled_charges_invoiced" : {
      "description" : "Triggered when unbilled charges are invoiced\n",
      "post" : {
        "summary" : "Triggered when unbilled charges are invoiced",
        "description" : "Triggered when unbilled charges are invoiced\n",
        "operationId" : "onUnbilled_charges_invoicedWebhook",
        "requestBody" : {
          "description" : "Payload for unbilled_charges_invoiced event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/UnbilledChargesInvoicedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "tax_withheld_recorded" : {
      "description" : "Triggered when a tax withheld is recorded for an invoice.\n",
      "post" : {
        "summary" : "Triggered when a tax withheld is recorded for an invoice.",
        "description" : "Triggered when a tax withheld is recorded for an invoice.\n",
        "operationId" : "onTax_withheld_recordedWebhook",
        "requestBody" : {
          "description" : "Payload for tax_withheld_recorded event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/TaxWithheldRecordedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "coupon_codes_updated" : {
      "description" : "Triggered when coupon codes are updated in coupon set.\n",
      "post" : {
        "summary" : "Triggered when coupon codes are updated in coupon set.",
        "description" : "Triggered when coupon codes are updated in coupon set.\n",
        "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.\n",
      "post" : {
        "summary" : "Triggered when the virtual bank account is updated.",
        "description" : "Triggered when the virtual bank account is updated.\n",
        "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.\n",
      "post" : {
        "summary" : "Triggered when contract term is created.",
        "description" : "Triggered when contract term is created.\n",
        "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.\n",
      "post" : {
        "summary" : "Triggered when the subscription's recurring items are changed.",
        "description" : "Triggered when the subscription's recurring items are changed.\n",
        "operationId" : "onSubscription_changedWebhook",
        "requestBody" : {
          "description" : "Payload for subscription_changed event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/SubscriptionChangedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "subscription_items_renewed" : {
      "post" : {
        "summary" : "Triggered when one or more Subscription Items are renewed",
        "operationId" : "onSubscription_items_renewedWebhook",
        "requestBody" : {
          "description" : "Payload for subscription_items_renewed event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/SubscriptionItemsRenewedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "rule_created" : {
      "post" : {
        "summary" : "Triggered when a rule is created",
        "operationId" : "onRule_createdWebhook",
        "requestBody" : {
          "description" : "Payload for rule_created event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/RuleCreatedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "contract_term_cancelled" : {
      "description" : "Triggered when contract term is cancelled.\n",
      "post" : {
        "summary" : "Triggered when contract term is cancelled.",
        "description" : "Triggered when contract term is cancelled.\n",
        "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.\n",
      "post" : {
        "summary" : "Triggered when a contract term is renewed.",
        "description" : "Triggered when a contract term is renewed.\n",
        "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.\n",
      "post" : {
        "summary" : "Event triggered when an invoice is deleted.",
        "description" : "Event triggered when an invoice is deleted.\n",
        "operationId" : "onInvoice_deletedWebhook",
        "requestBody" : {
          "description" : "Payload for invoice_deleted event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/InvoiceDeletedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "payment_failed" : {
      "description" : "Triggered when the payment collection fails.\n",
      "post" : {
        "summary" : "Triggered when the payment collection fails.",
        "description" : "Triggered when the payment collection fails.\n",
        "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.\n",
      "post" : {
        "summary" : "Triggered when a credit note is deleted.",
        "description" : "Triggered when a credit note is deleted.\n",
        "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.\n",
      "post" : {
        "summary" : "Triggered when a tax withheld is refunded.",
        "description" : "Triggered when a tax withheld is refunded.\n",
        "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.\n",
      "post" : {
        "summary" : "Triggered when contract term is completed.",
        "description" : "Triggered when contract term is completed.\n",
        "operationId" : "onContract_term_completedWebhook",
        "requestBody" : {
          "description" : "Payload for contract_term_completed event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/ContractTermCompletedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "card_updated" : {
      "description" : "Triggered when the card is updated for a customer.\n",
      "post" : {
        "summary" : "Triggered when the card is updated for a customer.",
        "description" : "Triggered when the card is updated for a customer.\n",
        "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.\n",
      "post" : {
        "summary" : "Triggered when a customer is created.",
        "description" : "Triggered when a customer is created.\n",
        "operationId" : "onCustomer_createdWebhook",
        "requestBody" : {
          "description" : "Payload for customer_created event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/CustomerCreatedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "pending_invoice_updated" : {
      "description" : "Triggered when you make the following changes to a pending invoice: add a charge, add a non-recurring addon, or delete a line item.\n",
      "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.\n",
        "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.\n",
      "post" : {
        "summary" : "Triggered when a quote is updated.",
        "description" : "Triggered when a quote is updated.\n",
        "operationId" : "onQuote_updatedWebhook",
        "requestBody" : {
          "description" : "Payload for quote_updated event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/QuoteUpdatedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "subscription_renewal_reminder" : {
      "description" : "Triggered 3 days before each subscription's renewal.\n",
      "post" : {
        "summary" : "Triggered 3 days before each subscription's renewal.",
        "description" : "Triggered 3 days before each subscription's renewal.\n",
        "operationId" : "onSubscription_renewal_reminderWebhook",
        "requestBody" : {
          "description" : "Payload for subscription_renewal_reminder event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/SubscriptionRenewalReminderEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "payment_source_updated" : {
      "description" : "Triggered when the payment source is updated and also when a role is assigned to it.\n",
      "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 and also when a role is assigned to it.\n",
        "operationId" : "onPayment_source_updatedWebhook",
        "requestBody" : {
          "description" : "Payload for payment_source_updated event",
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/PaymentSourceUpdatedEvent"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "Webhook received successfully"
          }
        },
        "deprecated" : false
      }
    },
    "authorization_voided" : {
      "description" : "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",
      "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.\n",
        "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
      }
    }
  }
}