Resource object representing subscription
" }, "advance_invoice_schedules" : { "type" : "array", "description" : "Resource object representing advance_invoice_schedule
", "items" : { "$ref" : "#/components/schemas/AdvanceInvoiceSchedule", "description" : "Resource object representing advance_invoice_schedule" }, "example" : null } }, "required" : [ "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/remove_coupons" : { "post" : { "summary" : "Remove coupons", "description" : "Removes Coupons associated with the Subscription. If the param 'coupon_ids' is not specified, all the Coupons linked to the Subscription will be removed.\n", "operationId" : "remove_coupons", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" } }, "required" : [ "customer", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/resume" : { "post" : { "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\"?**\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\\* immediately -\n\nResume immediately\n\\* specific_date -\n\nResume 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\\* add_to_unbilled_charges -\n\nAdd to unbilled charges\n\\* invoice_immediately -\n\nInvoice 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\\* no_action -\n\nRetain as unpaid\n\\* schedule_payment_collection -\n\nCollect 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\\* customer -\n\nPass this value to indicate that the request is initiated by the customer\n\\* merchant -\n\nPass 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\\* alipay_hk - \\* card -\n\ncard\n\\* twint -\n\nPayments made via Twint\n\\* swish -\n\nPayments made via Swish\n\\* after_pay -\n\nPayments made via Afterpay\n\\* netbanking_emandates -\n\nnetbanking_emandates\n\\* grab_pay -\n\nPayments made via GrabPay\n\\* paypay - \\* payconiq_by_bancontact -\n\nPayments made via Payconiq by Bancontact.\n\\* dotpay -\n\ndotpay\n\\* faster_payments -\n\nFaster Payments\n\\* upi -\n\nupi\n\\* kbc_payment_button -\n\nKBC Payment Button\n\\* electronic_payment_standard -\n\nElectronic Payment Standard\n\\* klarna -\n\nPayments made via Klarna.\n\\* payme -\n\nPayments made via PayMe\n\\* direct_debit -\n\ndirect_debit\n\\* sepa_instant_transfer -\n\nSepa Instant Transfer\n\\* bancontact -\n\nbancontact\n\\* go_pay -\n\nPayments made via GoPay\n\\* pay_by_bank -\n\nPay By Bank\n\\* google_pay -\n\ngoogle_pay\n\\* apple_pay -\n\napple_pay\n\\* online_banking_poland - \\* trustly -\n\nTrustly\n\\* gcash - \\* naver_pay -\n\nPayments made via Naver Pay.\n\\* stablecoin -\n\nPayments made via Stablecoin.\n\\* giropay -\n\ngiropay\n\\* paypal_express_checkout -\n\npaypal_express_checkout\n\\* pix -\n\nPix\n\\* venmo -\n\nVenmo\n\\* klarna_pay_now -\n\nKlarna Pay Now\n\\* alipay -\n\nPayments made via Alipay.\n\\* sofort -\n\nsofort\n\\* amazon_payments -\n\nAmazon Payments\n\\* ideal -\n\nideal\n\\* kakao_pay -\n\nPayments made via Kakao Pay.\n\\* pay_to -\n\nPayTo\n\\* south_korean_cards - \\* boleto -\n\nboleto\n\\* pay_co -\n\nPayments made via PayCo\n\\* revolut_pay -\n\nPayments made via Revolut Pay.\n\\* wechat_pay -\n\nPayments made via WeChat Pay.\n\\* cash_app_pay -\n\nPayments made via Cash App 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" ], "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 or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_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.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's deviceResource object representing subscription
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" }, "invoice" : { "$ref" : "#/components/schemas/Invoice", "description" : "Resource object representing invoice
" }, "unbilled_charges" : { "type" : "array", "description" : "Resource object representing unbilled_charge
", "items" : { "$ref" : "#/components/schemas/UnbilledCharge", "description" : "Resource object representing unbilled_charge" }, "example" : null } }, "required" : [ "customer", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/regenerate_invoice" : { "post" : { "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:
status is not voided.Returns one of the following depending on the value of invoice_immediately:
true: an invoice object that corresponds to the regenerated invoice.false: a list of unbilled_charge objects corresponding to all the unbilled charges created for the current term of the subscription.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.
Only applicable when Consolidated Invoicing\nis enabled for the customer. Set to false\nto leave the current term charge for the subscription as unbilled.\nOnce you have done this for all suitable subscriptions of the customer, call Create an invoice for unbilled charges\nto invoice them.
Resource object representing invoice
" }, "unbilled_charges" : { "type" : "array", "description" : "Resource object representing unbilled_charge
", "items" : { "$ref" : "#/components/schemas/UnbilledCharge", "description" : "Resource object representing unbilled_charge" }, "example" : null } }, "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions" : { "get" : { "summary" : "List subscriptions", "description" : "Important\nFor sites where both legacy and latest 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.
Override options:
chargebee-response-schema-type: items → Return response in latest product catalog format only.chargebee-response-schema-type: plans_addons → Return response in legacy product catalog format only.Returns a list of subscriptions meeting all the conditions specified in the filter parameters below.
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.
Indicates whether to include deleted objects in the list. The deleted objects have the attribute deleted\nas true\n.
optional, timestamp(UTC) in seconds filter
\nTime at which the subscription status\nlast changed to\nactive.\nFor example, this value is updated when an in_trial\nor\ncancelled\nsubscription activates.\nSupported operators :\nafter, before, on, between, is_present
Example →\nactivated_at[after] = "1435054328"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "1435054328", "properties" : { "after" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "before" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "on" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[\\d{10},\\d{10}\\]$", "example" : null }, "is_present" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } } } }, { "name" : "next_billing_at", "in" : "query", "description" : "optional, timestamp(UTC) in seconds filter
\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.\nSupported operators :\nafter, before, on, between
Example →\nnext_billing_at[after] = "1435054328"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "1435054328", "properties" : { "after" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "before" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "on" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[\\d{10},\\d{10}\\]$", "example" : null } } } }, { "name" : "cancelled_at", "in" : "query", "description" : "optional, timestamp(UTC) in seconds filter\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
\nIf true\n, there are subscription changes scheduled on next renewal. Possible values are : true, false
Supported operators :\nis
\nExample →\nhas_scheduled_changes[is] = "true"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "true", "properties" : { "is" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } } } }, { "name" : "updated_at", "in" : "query", "description" : "optional, timestamp(UTC) in seconds filter
\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.\nSupported operators :\nafter, before, on, between
Example →\nupdated_at[after] = "1243545465"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "1243545465", "properties" : { "after" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "before" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "on" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[\\d{10},\\d{10}\\]$", "example" : null } } } }, { "name" : "offline_payment_method", "in" : "query", "description" : "optional, enumerated string filter\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 \\* \\`cash\\` - Cash \\* \\`check\\` - Check \\* \\`bank_transfer\\` - Bank Transfer \\* \\`ach_credit\\` - ACH Credit \\* \\`sepa_credit\\` - SEPA Credit \\* \\`boleto\\` - Boleto \\* \\`us_automated_bank_transfer\\` - US Automated Bank Transfer \\* \\`eu_automated_bank_transfer\\` - EU Automated Bank Transfer \\* \\`uk_automated_bank_transfer\\` - UK Automated Bank Transfer \\* \\`jp_automated_bank_transfer\\` - JP Automated Bank Transfer \\* \\`mx_automated_bank_transfer\\` - MX Automated Bank Transfer \\* \\`custom\\` - Custom\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 }, "is_not" : { "type" : "string", "description" : "\\* \\`no_preference\\` - No Preference \\* \\`cash\\` - Cash \\* \\`check\\` - Check \\* \\`bank_transfer\\` - Bank Transfer \\* \\`ach_credit\\` - ACH Credit \\* \\`sepa_credit\\` - SEPA Credit \\* \\`boleto\\` - Boleto \\* \\`us_automated_bank_transfer\\` - US Automated Bank Transfer \\* \\`eu_automated_bank_transfer\\` - EU Automated Bank Transfer \\* \\`uk_automated_bank_transfer\\` - UK Automated Bank Transfer \\* \\`jp_automated_bank_transfer\\` - JP Automated Bank Transfer \\* \\`mx_automated_bank_transfer\\` - MX Automated Bank Transfer \\* \\`custom\\` - Custom\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 }, "in" : { "type" : "string", "description" : "\\* \\`no_preference\\` - No Preference \\* \\`cash\\` - Cash \\* \\`check\\` - Check \\* \\`bank_transfer\\` - Bank Transfer \\* \\`ach_credit\\` - ACH Credit \\* \\`sepa_credit\\` - SEPA Credit \\* \\`boleto\\` - Boleto \\* \\`us_automated_bank_transfer\\` - US Automated Bank Transfer \\* \\`eu_automated_bank_transfer\\` - EU Automated Bank Transfer \\* \\`uk_automated_bank_transfer\\` - UK Automated Bank Transfer \\* \\`jp_automated_bank_transfer\\` - JP Automated Bank Transfer \\* \\`mx_automated_bank_transfer\\` - MX Automated Bank Transfer \\* \\`custom\\` - Custom\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" ], "pattern" : "^\\[(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom)(,(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`no_preference\\` - No Preference \\* \\`cash\\` - Cash \\* \\`check\\` - Check \\* \\`bank_transfer\\` - Bank Transfer \\* \\`ach_credit\\` - ACH Credit \\* \\`sepa_credit\\` - SEPA Credit \\* \\`boleto\\` - Boleto \\* \\`us_automated_bank_transfer\\` - US Automated Bank Transfer \\* \\`eu_automated_bank_transfer\\` - EU Automated Bank Transfer \\* \\`uk_automated_bank_transfer\\` - UK Automated Bank Transfer \\* \\`jp_automated_bank_transfer\\` - JP Automated Bank Transfer \\* \\`mx_automated_bank_transfer\\` - MX Automated Bank Transfer \\* \\`custom\\` - Custom\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" ], "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
\nSet to false\nto override for this subscription, the site-level setting\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.\nPossible values are : true, false
Supported operators :\nis
\nExample →\nauto_close_invoices[is] = "true"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "true", "properties" : { "is" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } } } }, { "name" : "override_relationship", "in" : "query", "description" : "optional, boolean filter
\nIf true\n, ignores the hierarchy relationship\nand uses customer as payment and invoice owner. Possible values are : true, false
Supported operators :\nis
\nExample →\noverride_relationship[is] = "false"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "false", "properties" : { "is" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } } } }, { "name" : "sort_by", "in" : "query", "description" : "optional, string filter\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. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "pattern" : "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "pattern" : "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\]$", "example" : null } } } }, { "name" : "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.
Note:\nThis operation optionally supports 3DS verification flow. To achieve the same, create the Payment Intent\nand pass it as input parameter to this API.
Creates a new subscription along with the customer. You can attach a plan, plan quantity, one or more addons and coupon while creating this subscription.
If 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.
If the plan has trial period or if the trial_end is specified explicitly, the subscription will be created in 'in_trial' state.
If the card details are passed, it is not charged until the end of the trial period. Incase you need to verify the card you could enable the 'card verification option' in the gateway settings.
If the plan does not have a trial period and if any of the recurring items has charges, then a invoice would be raised immediately. If 'auto_collection' is turned 'on', then card attributes are mandatory and subscription will be created only if the payment was successful.
Passing card details to this API involves PCI liability at your end as sensitive card information passes through your servers. If you wish to avoid that, you can use one of the following integration methodologies if applicable
Legacy behavior:
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 and the vat_number parameters each time you make this request, to avoid losing the same information at the customer-level.billing_address and vat_number of the customer.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 or not.
\nbilling_cycles is not provided, then the billing cycles set for the plan is used. Moreover, once the billing_cycles have completed, the subscription cancels.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.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:
\nstart_date cannot be earlier than 14th February.\n.The Chargebee payment token generated by Chargebee JS.
\nNote:\nThe payment token created via Chargebee JS uses the gateway selected through Smart Routing.\nExplicitly passing a gateway_id\nin this API call will not override the gateway associated with the token.
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:
invoice_date must be in the past.start_date.invoice_immediately is true.\n.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.\nThe default value is as per the site settings\n.
\nNote:\ninvoice_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.
.
", "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\\* week -\n\nCharge based on week(s)\n\\* month -\n\nCharge based on month(s)\n\\* day -\n\nCharge based on day(s)\n\\* year -\n\nCharge 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\n.
The unique ID of the customer for which this subscription\nresource should be created.
Specifies if the customer is liable for tax
\n* exempt -entity_code or exempt_number attributes if you use Chargebee's AvaTax for Sales or specify exemption_details attribute if you use Chargebee's AvaTax for Communications 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.Computes tax for the customer based on the site configuration.\nIn some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that's not available either, the tax is taken as zero.
", "enum" : [ "taxable", "exempt" ], "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\\* med2 -\n\nUS Medical Device Excise Tax with taxable sales tax\n\\* med1 -\n\nUS Medical Device Excise Tax with exempt sales tax\n\\* b -\n\nState government\n\\* c -\n\nTribe/Status Indian/Indian Band\n\\* a -\n\nFederal government\n\\* f -\n\nReligious organization\n\\* g -\n\nResale\n\\* d -\n\nForeign diplomat\n\\* e -\n\nCharitable or benevolent organization\n\\* j -\n\nDirect pay permit\n\\* k -\n\nDirect mail\n\\* h -\n\nCommercial agricultural production\n\\* i -\n\nIndustrial production/manufacturer\n\\* n -\n\nLocal government\n\\* l -\n\nOther or custom\n\\* m -\n\nEducational organization\n\\* r -\n\nNon-resident\n\\* p -\n\nCommercial aquaculture\n\\* q -\n\nCommercial 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\\* wholesale -\n\nWhole-sale\n\\* other -\n\nOther\n\\* government -\n\nGovernment\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\\* on -\n\nWhenever an invoice is created, an automatic attempt to charge the customer's payment method is made.\n\\* off -\n\nAutomatic 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\\* check -\n\nCheck\n\\* bank_transfer -\n\nBank Transfer\n\\* custom -\n\nCustom\n\\* cash -\n\nCash\n\\* no_preference -\n\nNo Preference\n\\* eu_automated_bank_transfer -\n\nEU Automated Bank Transfer\n\\* boleto -\n\nBoleto\n\\* uk_automated_bank_transfer -\n\nUK Automated Bank Transfer\n\\* sepa_credit -\n\nSEPA Credit\n\\* ach_credit -\n\nACH Credit\n\\* mx_automated_bank_transfer -\n\nMX Automated Bank Transfer\n\\* us_automated_bank_transfer -\n\nUS Automated Bank Transfer\n\\* jp_automated_bank_transfer -\n\nJP 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. This parameter can be provided only when Consolidated Invoicing is enabled.
Note:
Any invoices raised when a subscription activates from in_trial or future status, are not consolidated by default. Contact Support to enable consolidation for such invoices.
The VAT/tax registration number for the customer. For customers with billing_address
country\nas\nXI\n(which is United Kingdom - Northern Ireland\n), the first two characters of the full VAT number\ncan be overridden by setting\nvat_number_prefix\n.
An overridden value for the first two characters of the full VAT number.\nOnly applicable specifically for customers with billing_address
country\nas XI\n(which is United Kingdom - Northern Ireland\n).
When you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, you have the option of setting billing_address
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\nXI\nby default. However, if the VAT number was registered in UK, the value should be GB.\nSet\nvat_number_prefix\nto GB\nfor such cases.
The Peppol BIS scheme associated with the 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\n.
Tip:
If there are additional entity identifiers for the customer not associated with the vat_number, they can be provided as the entity_identifiers[] array.
The standard used for specifying the entity_identifier_scheme.\nCurrently only iso6523-actorid-upis\nis supported and is used by default when not provided.
Tip:
If there are additional entity identifiers for the customer not associated with the vat_number, they can be provided as the entity_identifiers[] array.
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.
Tip:
It is possible to set a value for this flag even when E-Invoicing is disabled. However, it comes into effect only when E-Invoicing is enabled.
Confirms that a customer is registered under GST. If set to true\nthen the Reverse Charge Mechanism\nis applicable. This field is applicable only when Australian GST is configured for your site.
The ISO 3166-2 state/province 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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if billing_state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_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.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's deviceThe billing address associated with the bank account. The value is a JSON object with the following keys and their values:- first_name:(string, max chars=150) The first name of the contact.
last_name:(string, max chars=150) The last name of the contact.company_name:(string, max chars=250) The company name for the address.line1:(string, max chars=180) The first line of the address.line2:(string, max chars=180) The second line of the address.country:(string) The name of the country for the address.country_code:(string, max chars=50) The two-letter, ISO 3166 alpha-2 country code for the address.state:(string, max chars=50) The name of the state or province for the address. When not provided, this is set automatically for US, Canada, India, and UAE.state_code:(string, max chars=50) The ISO 3166-2 state/province code without the country prefix. This is supported for USA, Canada, India, and UAE. For instance, for Arizona (USA), set state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC). For Dubai (UAE), set as DU (not AE-DU).city:(string, max chars=50) The city name for the address.postal_code:(string, max chars=20) The postal or ZIP code for the address.phone:(string, max chars=50) The contact phone number for the address.email:(string, max chars=70) The contact email address for the address.ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nIf you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, then XI\n(the code for United Kingdom - Northern Ireland\n) is available as an option.
checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_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.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's devicecheckout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_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.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's deviceThe ISO 3166-2 state/province 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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The ISO 3166-2 state/province 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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
Action to be taken when the contract term completes.
\n* cancel -Contract term completes and subscription is canceled.
\n* evergreen -Contract term completes and the subscription renews.
\n* renew -contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.The number of days before 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.
The unique id for the entity_identifier\nin Chargebee. When not provided, it is autogenerated.
The Peppol BIS scheme associated with the 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\n.
Tip:
If there is only one entity identifier for the customer and the value is the same as vat_number, then there is no need to provide the entity_identifiers[] array. See description for entity_identifiers[].
The value of the entity_identifier.\nThis identifies the customer entity on the Peppol network. For example: 10101010-STO-10\n.
Tip:
If there is only one entity identifier for the customer and the value is the same as vat_number, then there is no need to provide the entity_identifiers[] array. See description for entity_identifiers[].
The standard used for specifying the entity_identifier\nscheme.\nCurrently, only iso6523-actorid-upis\nis supported and is used by default when not provided.
Tip:
If there is only one entity identifier for the customer and the value is the same as vat_number, then there is no need to provide the entity_identifiers[] array. See description for entity_identifiers[].
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
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\n)
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
Resource object representing subscription
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" }, "invoice" : { "$ref" : "#/components/schemas/Invoice", "description" : "Resource object representing invoice
" }, "unbilled_charges" : { "type" : "array", "description" : "Resource object representing unbilled_charge
", "items" : { "$ref" : "#/components/schemas/UnbilledCharge", "description" : "Resource object representing unbilled_charge" }, "example" : null } }, "required" : [ "customer", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/move" : { "post" : { "summary" : "Move a subscription", "description" : "Moves a subscription from one customer to another asynchronously. All related resources such as unbilled_charge, invoice, credit_note, and transaction are also moved to the new customer.
After moving, Chargebee adds a comment to the original customer resource to document the move, including the to_customer_id and the ids of all the resources transferred to the destination customer.
Warning
auto_collection is on, it might fail after this operation. Refer to the warning in copy_payment_source for details.customer resource that is within an account hierarchy relationship.payment_due, pending, or posted associated with the subscription.credit_note resources with the statuses adjusted or refund_due should be associated with the subscription.If 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.
To know whether the operation was successful, we recommend that you watch for the subscription_changed event and see if subscription.customer_id has changed.
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.
Specifies the unique ID of the customer resource to which the subscription will be moved.
When true:\nIf the subscription has an associated payment_source:
payment_source resource is created.Note:\nDeleting any copy of the payment_source\nalso deletes the other copies and the details stored at the payment gateway.
When false:\nNo new payment source is created for the subscription. Moreover, if a payment_source is already linked to the subscription, it gets removed, meaning the subscription.payment_source_id is cleared.
Warning:\nWhen copy_payment_source\nis false\nand if subscription.auto_collection\nis enabled, auto-collection will fail, in turn preventing subscription renewal. To prevent auto-collection failure, link a payment source\nto the subscription after this operation.
Resource object representing subscription
" } }, "required" : [ "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/import_subscription" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\\* on -\n\nWhenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.\n\\* off -\n\nAutomatic 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\\* future -\n\nThe subscription is scheduled to start at a future date.\n\\* active -\n\nThe subscription is active and will be charged for automatically based on the items in it.\n\\* cancelled -\n\nThe subscription has been canceled and is no longer in service.\n\\* transferred -\n\nThe subscription has been transferred to another business entity within the organization.\n\\* in_trial -\n\nThe subscription is in trial.\n\\* non_renewing -\n\nThe subscription will be canceled at the end of the current term.\n\\* paused -\n\nThe subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html).\nThe 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.
\nNote:
For subscription status: non_renewing, active, and paused, current_term_end is required.
.
", "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.
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.
Time at which the subscription was started. Is null\nfor future\nsubscriptions as it is yet to be started.
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.
The following conditions must be satisfied when passing this parameter:
\nstatus 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.status is in_trial, activated_at must precede trial_startThis parameter should not be provided when passing status as future or cancelled.
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.
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\n.
Set as true\nif you want an invoice to be created for the subscription.
active or non_renewing status.current_term_start to current_term_end.The amount raised for the contract term till the time of importing the subscription. This amount is added to the total_contract_value
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
Action to be taken when the contract term completes.
\n* evergreen -Contract term completes and the subscription renews.
\n* renew -contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.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.
action_at_term_end for the new contract term is set to cancel.Contract term completes and subscription is canceled.
", "enum" : [ "renew", "evergreen", "cancel", "renew_once" ], "example" : null }, "cancellation_cutoff_period" : { "type" : "integer", "format" : "int32", "default" : 0, "deprecated" : false, "description" : "The number of days before contract_end\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.
The reference number for this transaction. For example, check number in case of check\npayment_method.\nThis parameter should be passed only if the invoice is created for current term.
The ISO 3166-2 state/province 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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
The price or per-unit-price of the addon. The value depends on the type of currency.
\nNote:
For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:
unit_price provided is $10When price overriding\nis enabled for the site, the price or per-unit price of the addon can be set here. The value set for the addon\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\nis enabled.
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
Resource object representing subscription
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" }, "invoice" : { "$ref" : "#/components/schemas/Invoice", "description" : "Resource object representing invoice
" } }, "required" : [ "customer", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/subscriptions" : { "post" : { "summary" : "Create subscription for customer", "description" : "**Note:**\nThis operation optionally supports 3DS verification flow. To achieve the same, create the [Payment Intent](/docs/api/getting-started)\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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" : "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 or not.
\nbilling_cycles is not provided, then the billing cycles set for the plan is used. Moreover, once the billing_cycles have completed, the subscription cancels.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.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:
\nstart_date cannot be earlier than 14th February.\n.If true\n, ignores the hierarchy relationship\nand uses customer as payment and invoice owner.
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:
invoice_date must be in the past.start_date.invoice_immediately is true.\n.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.\nThe default value is as per the site settings\n.
\nNote:\ninvoice_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.
.
", "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\\* week -\n\nCharge based on week(s)\n\\* month -\n\nCharge based on month(s)\n\\* day -\n\nCharge based on day(s)\n\\* year -\n\nCharge 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\n.
The ISO 3166-2 state/province 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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_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.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's deviceAction to be taken when the contract term completes.
\n* evergreen -Contract term completes and the subscription renews.
\n* renew -contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.Contract term completes and subscription is canceled.
", "enum" : [ "renew", "evergreen", "cancel" ], "example" : null }, "cancellation_cutoff_period" : { "type" : "integer", "format" : "int32", "default" : 0, "deprecated" : false, "description" : "The number of days before contract_end\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.
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
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\n)
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
Resource object representing subscription
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" }, "invoice" : { "$ref" : "#/components/schemas/Invoice", "description" : "Resource object representing invoice
" }, "unbilled_charges" : { "type" : "array", "description" : "Resource object representing unbilled_charge
", "items" : { "$ref" : "#/components/schemas/UnbilledCharge", "description" : "Resource object representing unbilled_charge" }, "example" : null } }, "required" : [ "customer", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/retrieve_advance_invoice_schedule" : { "get" : { "summary" : "Retrieve advance invoice", "description" : "Retrieves the *advance_invoice_schedule* for a subscription. Note that this endpoint is only applicable for *schedule_type = specific_dates* or fixed_intervals.\n", "operationId" : "retrieve_advance_invoice", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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
", "items" : { "$ref" : "#/components/schemas/AdvanceInvoiceSchedule", "description" : "Resource object representing advance_invoice_schedule" }, "example" : null } }, "required" : [ "advance_invoice_schedules" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/remove_scheduled_cancellation" : { "post" : { "summary" : "Remove scheduled cancellation", "description" : "Note: Cannot be called when the subscription is on a contract term. (That is, when the contract_term.status attribute is active.)
If 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.
While removing the scheduled cancellation, you may specify the number of billing cycles. If the billing cycle is not specified, the default billing cycle from the plan will be applied on the subscription.
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\n.
Action to be taken when the contract term completes.
\n* cancel -Contract term completes and subscription is canceled.
\n* evergreen -Contract term completes and the subscription renews.
\n* renew -contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.The number of days before 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.
Resource object representing subscription
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" } }, "required" : [ "customer", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/retrieve_with_scheduled_changes" : { "get" : { "summary" : "Retrieve with scheduled changes", "description" : "Retrieves a subscription with the scheduled changes applied. If the subscription has one or more ramps, this API returns the subscription with the upcoming ramp applied.
Note: Only the following attributes are changed
Resource object representing subscription
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" } }, "required" : [ "customer", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/reactivate" : { "post" : { "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\"?**\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?**\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\nstatus\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.
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:
\nreactivate_from cannot be earlier than 14th February.\n.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.\nThe default value is as per the site settings\n.
\nNote:\ninvoice_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.
.
", "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\\* delayed -\n\nSubscription period will be aligned with the configured billing date at the next renewal.\n\\* immediate -\n\nSubscription 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.\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.
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:
invoice_date must be in the past.invoice_date is not more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.reactivate_from or trial_end.invoice_immediately is true.\n.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\n.
Action to be taken when the contract term completes.
\n* evergreen -Contract term completes and the subscription renews.
\n* renew -contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.Contract term completes and subscription is canceled.
", "enum" : [ "renew", "evergreen", "cancel" ], "example" : null }, "cancellation_cutoff_period" : { "type" : "integer", "format" : "int32", "default" : 0, "deprecated" : false, "description" : "The number of days before contract_end\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.
checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_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.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's deviceResource object representing subscription
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" }, "invoice" : { "$ref" : "#/components/schemas/Invoice", "description" : "Resource object representing invoice
" }, "unbilled_charges" : { "type" : "array", "description" : "Resource object representing unbilled_charge
", "items" : { "$ref" : "#/components/schemas/UnbilledCharge", "description" : "Resource object representing unbilled_charge" }, "example" : null } }, "required" : [ "customer", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/charge_future_renewals" : { "post" : { "summary" : "Create advance invoice or invoicing schedules", "description" : "Creates an advance invoice or an advance invoicing schedule. When an advance invoice is generated, and auto_collection is on for the subscription, the payment_source 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 status.
non_renewing and cancelled subscriptions.schedule_type = immediate: the number of future billing cycles to be invoiced in advance. The invoicing is done for the remaining_billing_cycles of the subscription if that is less than terms_to_charge.schedule_type = fixed_intervals: The number of future billing cycles in one interval. The schedule is created such that the total number of billing cycles in the schedule does not exceed the remaining_billing_cycles of the subscription.\n.Whether the charge should be invoiced immediately or added to unbilled_charges.\nApplicable only when schedule_type\nis immediate\n.
The type of advance invoice or advance invoicing schedule.
\n* immediate -Charge immediately for the number of billing cycles specified by terms_to_charge\n.
Charge on specific dates.\nFor each date, specify the number of billing cycles\nto charge for. Up to 5 dates can be configured.
\n* fixed_intervals -Charge at fixed intervals of time. Specify the number of billing cycles\nthat constitute an interval and the number of days before each interval\nthat the invoice should be generated. Also specify when the schedule should end\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\nof the subscription. This parameter is applicable only when fixed_interval_schedule[end_schedule_on]\n= after_number_of_intervals
Specifies when the schedule should end.
\n* after_number_of_intervals -Advance invoices are generated a specified number of times
Advance invoices are generated for as long as the subscription is active.
\n* specific_date -End the advance invoicing schedule on a specific date\n.
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]\n= specific_date\n.
The number of billing cycles to charge for, on the date specified. Applicable only when schedule_type\nis specific_dates.
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\nis specific_dates\n.
Resource object representing subscription
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" }, "invoice" : { "$ref" : "#/components/schemas/Invoice", "description" : "Resource object representing invoice
" }, "advance_invoice_schedules" : { "type" : "array", "description" : "Resource object representing advance_invoice_schedule
", "items" : { "$ref" : "#/components/schemas/AdvanceInvoiceSchedule", "description" : "Resource object representing advance_invoice_schedule" }, "example" : null } }, "required" : [ "customer", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/add_charge_at_term_end" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\\* retail -\n\nTransaction is a sale to an end user\n\\* wholesale -\n\nTransaction is a sale to another company that will resell your product or service to another consumer\n\\* vendor_use -\n\nTransaction is for an item that is subject to vendor use tax\n\\* consumed -\n\nTransaction 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
" } }, "required" : [ "estimate" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/remove_scheduled_changes" : { "post" : { "summary" : "Remove scheduled changes", "description" : "Removes the subscription changes scheduled on next renewal. Advance charges, if any, will be refunded as credits and a new invoice will be generated on renewal.\n", "operationId" : "remove_scheduled_changes", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" }, "credit_notes" : { "type" : "array", "description" : "Resource object representing credit_note
", "items" : { "$ref" : "#/components/schemas/CreditNote", "description" : "Resource object representing credit_note" }, "example" : null } }, "required" : [ "customer", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/change_term_end" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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.\nThe default value is as per the site settings\n.
\nNote:\ninvoice_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.
.
", "example" : null } }, "required" : [ "term_ends_at" ], "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "subscription" : { "$ref" : "#/components/schemas/Subscription", "description" : "Resource object representing subscription
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" }, "invoice" : { "$ref" : "#/components/schemas/Invoice", "description" : "Resource object representing invoice
" }, "unbilled_charges" : { "type" : "array", "description" : "Resource object representing unbilled_charge
", "items" : { "$ref" : "#/components/schemas/UnbilledCharge", "description" : "Resource object representing unbilled_charge" }, "example" : null }, "credit_notes" : { "type" : "array", "description" : "Resource object representing credit_note
", "items" : { "$ref" : "#/components/schemas/CreditNote", "description" : "Resource object representing credit_note" }, "example" : null } }, "required" : [ "customer", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/delete" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" } }, "required" : [ "customer", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/import_subscription" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\\* on -\n\nWhenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.\n\\* off -\n\nAutomatic 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\n.
End of the current billing term. Subscription is renewed immediately after this. If not given, this will be calculated based on plan billing cycle.
\nNote:
For subscription status: non_renewing, active, and paused, current_term_end is required.
.
", "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.
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.
Time at which the subscription was started. Is null\nfor future\nsubscriptions as it is yet to be started.
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.
The following conditions must be satisfied when passing this parameter:
\nstatus 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.status is in_trial, activated_at must precede trial_startThis parameter should not be provided when passing status as future or cancelled.
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.
Set as true\nif you want an invoice to be created for the subscription.
active or non_renewing status.current_term_start to current_term_end.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.
Specifies if the customer is liable for tax
\n* exempt -entity_code or exempt_number attributes if you use Chargebee's AvaTax for Sales or specify exemption_details attribute if you use Chargebee's AvaTax for Communications 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.Computes tax for the customer based on the site configuration.\nIn some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that's not available either, the tax is taken as zero.
", "enum" : [ "taxable", "exempt" ], "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\\* med2 -\n\nUS Medical Device Excise Tax with taxable sales tax\n\\* med1 -\n\nUS Medical Device Excise Tax with exempt sales tax\n\\* b -\n\nState government\n\\* c -\n\nTribe/Status Indian/Indian Band\n\\* a -\n\nFederal government\n\\* f -\n\nReligious organization\n\\* g -\n\nResale\n\\* d -\n\nForeign diplomat\n\\* e -\n\nCharitable or benevolent organization\n\\* j -\n\nDirect pay permit\n\\* k -\n\nDirect mail\n\\* h -\n\nCommercial agricultural production\n\\* i -\n\nIndustrial production/manufacturer\n\\* n -\n\nLocal government\n\\* l -\n\nOther or custom\n\\* m -\n\nEducational organization\n\\* r -\n\nNon-resident\n\\* p -\n\nCommercial aquaculture\n\\* q -\n\nCommercial 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\\* wholesale -\n\nWhole-sale\n\\* other -\n\nOther\n\\* government -\n\nGovernment\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\\* senior_citizen -\n\nWhen 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 -\n\nWhen the purchase is made at a place of business\n\\* residential -\n\nWhen the purchase is made by a customer for home use\n\\* industrial -\n\nWhen 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\\* on -\n\nWhenever an invoice is created, an automatic attempt to charge the customer's payment method is made.\n\\* off -\n\nAutomatic 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
country\nas\nXI\n(which is United Kingdom - Northern Ireland\n), the first two characters of the full VAT number\ncan be overridden by setting\nvat_number_prefix\n.
An overridden value for the first two characters of the full VAT number.\nOnly applicable specifically for customers with billing_address
country\nas XI\n(which is United Kingdom - Northern Ireland\n).
When you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, you have the option of setting billing_address
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\nXI\nby default. However, if the VAT number was registered in UK, the value should be GB.\nSet\nvat_number_prefix\nto GB\nfor such cases.
The amount raised for the contract term till the time of importing the subscription. This amount is added to the total_contract_value
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
Action to be taken when the contract term completes.
\n* renew_once -Used when you want to renew the contract term just once. Does the following: - Contract term completes and a new contract term is started for the number of billing cycles specified in contract_billing_cycle_on_renewal.
action_at_term_end for the new contract term is set to cancel.Contract term completes and subscription is canceled.
\n* evergreen -Contract term completes and the subscription renews.
\n* renew -contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.The number of days before 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.
The ISO 3166-2 state/province 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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if billing_state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_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.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's deviceISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nIf you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, then XI\n(the code for United Kingdom - Northern Ireland\n) is available as an option.
checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_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.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's deviceThe ISO 3166-2 state/province 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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The ISO 3166-2 state/province 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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The reference number for this transaction. For example, check number in case of check\npayment_method.\nThis parameter should be passed only if the invoice is created for current term.
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
The price or per-unit-price of the addon. The value depends on the type of currency.
\nNote:
For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:
unit_price provided is $10When price overriding\nis enabled for the site, the price or per-unit price of the addon can be set here. The value set for the addon\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\nis enabled.
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
Resource object representing subscription
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" }, "invoice" : { "$ref" : "#/components/schemas/Invoice", "description" : "Resource object representing invoice
" } }, "required" : [ "customer", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/import_unbilled_charges" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\\* plan -\n\nIndicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)\nid\n\\* plan_setup -\n\nIndicates that this lineitem is based on 'Plan Setup' charge. The 'entity_id' attribute specifies the [plan](/docs/api/v2/pcv-1/plans/plan-object)\nid\n\\* adhoc -\n\nIndicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case\n\\* addon -\n\nIndicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the [addon](/docs/api/v2/pcv-1/addons/addon-object)\nid\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\nis enabled.
The type of deduction and the amount to which it is applied.
\n* document_level_coupon -The deduction is due to a coupon applied to the invoice sub_total.\nThe coupon id is passed as entity_id\n.
The deduction is due to a coupon applied to line item. The coupon id\nis passed as entity_id\n.
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.
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.
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\nis enabled.
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\nis enabled.
The decimal representation of the quantity purchased from this tier. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
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\nis enabled.
Resource object representing unbilled_charge
", "items" : { "$ref" : "#/components/schemas/UnbilledCharge", "description" : "Resource object representing unbilled_charge" }, "example" : null } }, "required" : [ "unbilled_charges" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/remove_scheduled_resumption" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" } }, "required" : [ "customer", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}" : { "get" : { "summary" : "Retrieve a subscription", "description" : "Important\nFor sites where both legacy and latest 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.
Override options:
chargebee-response-schema-type: items → Return response in latest product catalog format only.chargebee-response-schema-type: plans_addons → Return response in legacy product catalog format only.Retrieves details of a subscription.
Resource object representing subscription
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" } }, "required" : [ "customer", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] }, "post" : { "summary" : "Update a subscription", "description" : "**Note:**\n\n* This operation optionally supports 3DS verification flow. To achieve the same, create the [Payment Intent](/docs/api/getting-started) and pass it as input parameter to this API.\n* When the **Remove mandatory add-ons from old plan during subscription plan update** setting is [enabled](https://www.chargebee.com/docs/1.0/subscriptions.html#editing-a-subscription_remove-mandatory-addons) on your Chargebee site, all [mandatory addons](/docs/api/attached_items) with the old plan will be automatically removed during the subscription update to a new plan.\n\nYou can modify the plan, plan quantity and add or remove addons for the subscription. By default the changes are applied immediately and the charges (/credits) are prorated and adjusted with the next billing term. You may also choose to effect the changes at the end of the current term by passing **end_of_term** as \"true\". In this case proration will not be done.\n\nOnly the parameters that are passed are modified for the subscription. Rest will reflect the existing values.\n\nBy default, the addons passed are appended to the existing list of addons for this subscription. In case a passed addon already exists for this subscription, quantity value is replaced. If you want to completely replace the addons for this subscription, pass **replace_addon_list** as \"true\".\n\n[Card](/docs/api/cards/card-object) and 'vat_number' attributes can also be passed during subscription update. If they are passed, corresponding Billing Info attributes - the [Billing Address](/docs/api/customers/customer-object) and 'vat_number' - will be replaced automatically.\n\nPassing credit card details to this API involves PCI liability at your end as sensitive card info passes through your servers. If you wish to avoid that, you can use one of the following integration methodologies if applicable\n\n* If you are using Stripe gateway, you can use [Stripe.js](https://stripe.com/docs/stripe.js) with your checkout form. Take a look at this [Stripe tutorial](https://stripe.com/docs/payments/accept-a-payment-charges) for more details.\n* If you are using Braintree gateway, you can use [Braintree.js](https://www.braintreepayments.com/docs/javascript) with your checkout form. Please refer this [tutorial](https://www.chargebee.com/tutorials/braintree-js-example.html) for more details.\n* If you are using Authorize.Net gateway, you use [Accept.js](https://developer.authorize.net/api/reference/features/acceptjs.html) with your checkout form.\n* If you are using the Adyen gateway, you will have to use the Adyen's [Client Side Encryption](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/cse-integration-ecommerce) to encrypt sensitive cardholder data. Once the cardholder data is encrypted, pass the value in adyen.encrypted.data as temp token in this API.\n* You can also use our [Hosted Pages](https://www.chargebee.com/docs/hosted_pages.html) based integration.\n\n**Proration Scenario:** A customer changes from a $15 plan to $30 plan after 15 days of a monthly term. He will be charged for $7.50 immediately. The following Credit Note and Invoice will be generated \n\n|-------------------------------|-------|\n| **Credit Note** |\n| Prorated credits for Old Plan | $7.50 |\n\n|-------------------------------|---------|\n| **Invoice** |\n| Prorated charges for New Plan | $15.00 |\n| Total | $15.00 |\n| Credits | ($7.50) |\n| **Amount Due** | $7.50 |\n\nMeanwhile downgrading will result in net credits being created which will be applied when the subscription is charged on start of the next term. Learn more about our proration scenarios [here](https://www.chargebee.com/docs/proration.html).\n\n**Billing Cycle:** The billing period for a subscription does not change if the plans intervals of both old and new are same. However, if a customer changes to a plan that has different billing interval(say monthly to yearly), the billing period is reset. Customer is charged immediately for the modified subscription after applying credit for the unused period for the old subscription.\n**Card and VAT number Input:** If they are passed, corresponding [Billing Address](/docs/api/customers/customer-object) attributes and [vat_number](/docs/api/customers/customer-object) will be replaced. i.e existing values for Billing Address and 'vat_number' will be cleared and the new values will be set.\nIf an invoice gets generated during this operation, available Credits and Excess Payments will be automatically applied.\n\n**Advance charges**, if any, will be refunded as credits and a new invoice will be generated on renewal.\n", "operationId" : "update_a_subscription", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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.\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.
When price overriding\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\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\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.
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:
invoice_date must be in the past.invoice_date is not more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.changes_scheduled_at, reactivate_from, or trial_end.invoice_immediately is true.\n.The new start date of a future\nsubscription. Applicable only for future\nsubscriptions.
The time at which the trial has ended or will end for the subscription. Set it to 0 to have no trial period.
Note
status is future, in_trial, or cancelled.changes_scheduled_at or start_date.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.The number of subscription billing cycles to invoice in advance.\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.
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.\nNote:\nIt is recommended not to pass this parameter along with changed_scheduled_at.\nreactivate_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:
changes_scheduled_at cannot be earlier than 14th February.\n.List of coupons to be applied to this subscription. You can provide coupon ids or 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.
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.
true: Prorated credits or charges are created as applicable for this change.false: The subscription is changed without creating any credits or charges.Caveat
For further changes within the same billing term, when prorate is set to true, credits are not created when all the conditions below hold true:
An immediate previous change was made
prorate set to false andSay 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).\nNote:\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.
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]
The Chargebee payment token generated by Chargebee JS.
\nNote:\nThe payment token created via Chargebee JS uses the gateway selected through Smart Routing.\nExplicitly passing a gateway_id\nin this API call will not override the gateway associated with the token.
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.\nThe default value is as per the site settings\n.
\nNote:\ninvoice_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.
.
", "example" : null }, "override_relationship" : { "type" : "boolean", "deprecated" : false, "description" : "If true\n, ignores the hierarchy relationship\nand uses customer as payment and invoice owner.
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.\nchanges_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:
Backdating must be enabled for subscription change operations.
\nOnly the following changes can be backdated:
\nChanges in the recurring items or their prices.
\nAddition of non-recurring items.
\nSubscription status is active, cancelled, or non_renewing.
The current day of the month does not exceed the limit set in Chargebee for backdating subscription change. This limit is typically the day of the month by which the accounting for the previous month must be closed.
\nThe date is on or after current_term_start.
The date is on or after the last date/time any of the following changes were made:
\nChanges in the recurring items or their prices.
\nAddition of non-recurring items.
\nThe 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..
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.
When the quote is converted, this attribute determines the date/time as of when the subscription change is to be carried out.
\n* end_of_term -The change is carried out at the end of the current billing cycle of the subscription.
\n* specific_date -The change is carried out as of the date specified under changes_scheduled_at\n.
The change is carried out immediately.
", "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\n.
The ISO 3166-2 state/province 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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if billing_state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_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.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's deviceISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nIf you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, then XI\n(the code for United Kingdom - Northern Ireland\n) is available as an option.
checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_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.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's devicecheckout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_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.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's deviceThe ISO 3166-2 state/province 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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The ISO 3166-2 state/province 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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The VAT/tax registration number for the customer. For customers with billing_address
country\nas\nXI\n(which is United Kingdom - Northern Ireland\n), the first two characters of the full VAT number\ncan be overridden by setting\nvat_number_prefix\n.
An overridden value for the first two characters of the full VAT number.\nOnly applicable specifically for customers with billing_address
country\nas XI\n(which is United Kingdom - Northern Ireland\n).
When you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, you have the option of setting billing_address
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\nXI\nby default. However, if the VAT number was registered in UK, the value should be GB.\nSet\nvat_number_prefix\nto GB\nfor such cases.
The Peppol BIS scheme associated with the 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\n.
Tip:
If there are additional entity identifiers for the customer not associated with the vat_number, they can be provided as the entity_identifiers[] array.
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.
Tip:
It is possible to set a value for this flag even when E-Invoicing is disabled. However, it comes into effect only when E-Invoicing is enabled.
The standard used for specifying the entity_identifier_scheme.\nCurrently only iso6523-actorid-upis\nis supported and is used by default when not provided.
Tip:
If there are additional entity identifiers for the customer not associated with the vat_number, they can be provided as the entity_identifiers[] array.
Confirms that a customer is registered under GST. If set to true\nthen the Reverse Charge Mechanism\nis applicable. This field is applicable only when Australian GST is configured for your site.
Action to be taken when the contract term completes.
\n* renew_once -Used when you want to renew the contract term just once. Does the following: - Contract term completes and a new contract term is started for the number of billing cycles specified in contract_billing_cycle_on_renewal.
action_at_term_end for the new contract term is set to cancel.Contract term completes and subscription is canceled.
\n* evergreen -Contract term completes and the subscription renews.
\n* renew -contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.The number of days before 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.
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
Amount that will override the Addon's default price. The unit depends on the type of currency.\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.
When price overriding\nis enabled for the site, the price or per-unit price of the addon can be set here. The value set for the addon\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\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.
The time at which the trial ends for the addon. To update this value, redo the complete addon set using replace_addon_list.\n(Addon trial periods must be enabled by Chargebee Support\n.)
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\nset to per_unit.\nYou may use this parameter only if the change to the subscription takes effect immediately.
Note
prorate parameter > addon.proration_type > site-wide proration setting.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.
", "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.
Resource object representing subscription
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" }, "invoice" : { "$ref" : "#/components/schemas/Invoice", "description" : "Resource object representing invoice
" }, "unbilled_charges" : { "type" : "array", "description" : "Resource object representing unbilled_charge
", "items" : { "$ref" : "#/components/schemas/UnbilledCharge", "description" : "Resource object representing unbilled_charge" }, "example" : null }, "credit_notes" : { "type" : "array", "description" : "Resource object representing credit_note
", "items" : { "$ref" : "#/components/schemas/CreditNote", "description" : "Resource object representing credit_note" }, "example" : null } }, "required" : [ "customer", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/import_contract_term" : { "post" : { "summary" : "Import contract term", "description" : "Import previous and active contract terms\n.
For contract terms in active\nstate, import is allowed only if the associated subscription is active\n, in_trial\n, future\nor non-renewing\n.
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\n.
The amount raised for the contract term till the time of importing the subscription. This amount is added to the total_contract_value
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
The sum of the totals\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.\nIf the subscription was imported\nwith the contract term, then this value includes the value passed for total_amount_raised\n.
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.
Action to be taken when the contract term completes.
\n* evergreen -Contract term completes and the subscription renews.
\n* renew_once -Used when you want to renew the contract term just once. Does the following: - Contract term completes and a new contract term is started for the number of billing cycles specified in contract_billing_cycle_on_renewal.
action_at_term_end for the new contract term is set to cancel.Contract term completes and subscription is canceled.
\n* renew -contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.The number of days before 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.
Resource object representing contract_term
" } }, "required" : [ "contract_term" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/override_billing_profile" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\\* off -\n\nAutomatic collection of charges will not be made for this subscription. Use this for offline payments.\n\\* on -\n\nWhenever 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
" }, "payment_source" : { "$ref" : "#/components/schemas/PaymentSource", "description" : "Resource object representing payment_source
" } }, "required" : [ "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/remove_scheduled_pause" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" } }, "required" : [ "customer", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/cancel" : { "post" : { "summary" : "Cancel a subscription", "description" : "Cancelling a subscription will move the subscription from its current state to Cancelled, and will stop all recurring actions.
You 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.
On 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.
Any 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.
Specifying 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.
If specified as schedule_payment_collection, payment collection for the amount due of past invoices will be attempted. The payment method available will be charged if auto-collection is enabled for the customer, and appropriate payment collection(payment succeeded or payment failed) events will be triggered. If the payment collection fails, no further retries will be made on the invoices. Note: If the invoices of the subscription are consolidated, and any of the subscriptions in the consolidated invoice are cancelled, these invoices will not be selected for collection.
If 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.
Specifying 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.
If the subscription has 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.
contract_term_cancel_option\ncancel_at\ncredit_option_for_current_term_charges\nunbilled_charges_option\naccount_receivables_handling\nrefundable_credits_handling\nAdvance charges, if any, will be refunded as credits.
Determines when to cancel the subscription.
\nThis parameter is not applicable.
\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
(Deprecated) Use cancel_option instead.\nApplicable only when the subscription does not have 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.
Specifies the date and time when the subscription should be canceled. Do not use this parameter when end_of_term is set to true.
Applicable only when contract_term_cancel_option is specific_date. Specifies the date and time to cancel the subscription and contract term.
You can set a past date to backdate the cancellation. Backdating is allowed only if the following conditions are met:
\ncurrent_term_start.cancel_at cannot be earlier than February 14.Specifies how to handle credits for current term charges when canceling immediately (i.e., cancel_option is immediately). If not specified, the site-level setting is used.
Specifies how to handle credits for current term charges when contract_term_cancel_option is terminate_immediately. If not specified, the site-level setting is used.
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.
", "enum" : [ "none", "prorate", "full" ], "example" : null }, "unbilled_charges_option" : { "type" : "string", "deprecated" : false, "description" : "Specifies how to handle unbilled charges when canceling immediately (i.e., cancel_option is immediately). If not specified, the site-level setting is used.
Specifies how to handle unbilled charges when contract_term_cancel_option is terminate_immediately. If not specified, the site-level setting is used.
An invoice is generated immediately with the unbilled charges.
\n* delete -The unbilled charges are deleted.
", "enum" : [ "invoice", "delete" ], "example" : null }, "account_receivables_handling" : { "type" : "string", "deprecated" : false, "description" : "Specifies how to handle past due invoices when canceling immediately (i.e., cancel_option is immediately). If not specified, the site-level setting is used.
Specifies how to handle past due invoices when contract_term_cancel_option is terminate_immediately. If not specified, the site-level setting is used.
No action is taken.
\n* write_off -Applies excess payments and refundable credits to past due invoices. Any remaining balance is written off.\nNote: The credit note for the write-off is not included in the API response.
\n* schedule_payment_collection -Applies excess payments and refundable credits to past due invoices. If any amount remains and auto_collection\nis on\n, the remaining amount is automatically charged to the available payment method.
Specifies how to handle refundable credits when canceling immediately (i.e., cancel_option is immediately). If not specified, the site-level setting is used.
Specifies how to handle refundable credits when contract_term_cancel_option is terminate_immediately. If not specified, the site-level setting is used.
Refunds remaining credits after applying them to any past due invoices.
\n* no_action -No action is taken.
", "enum" : [ "no_action", "schedule_refund" ], "example" : null }, "contract_term_cancel_option" : { "type" : "string", "deprecated" : false, "description" : "Required when the subscription has a contract term. Determines when to cancel the subscription along with the contract term.
\n* terminate_immediately -Cancels the subscription and contract term immediately. Sets the contract term's status to terminated and collects any termination fee, if applicable.\nTo specify the termination fee, include a single object in the subscription_items array. If not specified, the default termination fee is applied (if configured).
Prevents the contract term from renewing and schedules the subscription for cancellation at the end of the contract term.
\n* specific_date -Cancels the subscription and contract term on the date specified by cancel_at. Sets action_at_term_end to cancel.\nNote: Contact Chargebee Support to enable this option for your Chargebee site.
Cancels the subscription and contract term at the end of the current billing cycle. Sets action_at_term_end to cancel.\nNote: Contact Chargebee Support to enable this option for your Chargebee site.
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:
invoice_date must be in the past.invoice_date is not more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.cancel_at.\n.The unique id\nof the event-based addon that represents the termination fee.
Resource object representing subscription
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" }, "invoice" : { "$ref" : "#/components/schemas/Invoice", "description" : "Resource object representing invoice
" }, "unbilled_charges" : { "type" : "array", "description" : "Resource object representing unbilled_charge
", "items" : { "$ref" : "#/components/schemas/UnbilledCharge", "description" : "Resource object representing unbilled_charge" }, "example" : null }, "credit_notes" : { "type" : "array", "description" : "Resource object representing credit_note
", "items" : { "$ref" : "#/components/schemas/CreditNote", "description" : "Resource object representing credit_note" }, "example" : null } }, "required" : [ "customer", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/charge_addon_at_term_end" : { "post" : { "summary" : "Charge addon at term end", "description" : "Adds a \"non-recurring addon\" charge to a subscription which will be added to the invoice generated at the end of the current term. If there are any applicable coupons in the subscription, an appropriate discount will be applied.\n\nTo collect the charges for the non-recurring addon immediately, [use this API](/docs/api/v2/pcv-1/invoices/create-invoice-for-a-non-recurring-addon). \nIf any subscription changes happen before the end of the current term, these charges will be collected along with it.\n", "operationId" : "charge_addon_at_term_end", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "estimate" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/edit_advance_invoice_schedule" : { "post" : { "summary" : "Edit advance invoice schedule", "description" : "Modifies the [advance invoicing schedule](/docs/api/advance_invoice_schedules) for a subscription.\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\\* specific_dates -\n\nCharge on [specific dates](/docs/api/subscriptions/charge-future-renewals#specific_dates_schedule_date).\nFor each date, specify the [number of billing cycles](/docs/api/subscriptions/charge-future-renewals#specific_dates_schedule_terms_to_charge)\nto charge for. Up to 5 dates can be configured.\n\\* fixed_intervals -\n\nCharge at fixed intervals of time. Specify the [number of billing cycles](/docs/api/subscriptions/charge-future-renewals#terms_to_charge)\nthat constitute an interval and the number of [days before each interval](/docs/api/subscriptions/charge-future-renewals#fixed_interval_schedule_days_before_renewal)\nthat 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\nof the subscription. This parameter is applicable only when fixed_interval_schedule[end_schedule_on]\n= after_number_of_intervals
Specifies when the schedule should end.
\n* after_number_of_intervals -Advance invoices are generated a specified number of times
Advance invoices are generated for as long as the subscription is active.
\n* specific_date -End the advance invoicing schedule on a specific date\n.
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]\n= specific_date\n.
The number of billing cycles to charge for, on the date specified. Applicable only when schedule_type\nis specific_dates.
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\nis specific_dates\n.
Resource object representing advance_invoice_schedule
", "items" : { "$ref" : "#/components/schemas/AdvanceInvoiceSchedule", "description" : "Resource object representing advance_invoice_schedule" }, "example" : null } }, "required" : [ "advance_invoice_schedules" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/contract_terms" : { "get" : { "summary" : "List contract terms for a subscription", "description" : "Retrieves a list of contract term resources for the subscription specified in the path.\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "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.
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.
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.
cancelled_at date.List of options to pause the subscription.
\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) have been skipped
Pause immediately
\n* end_of_term -Pause at the end of current term
\n* specific_date -Pause on a specific date
", "enum" : [ "immediately", "end_of_term", "specific_date", "billing_cycles" ], "example" : null }, "pause_date" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Date on which the subscription will be paused. Applicable when specific_date option is chosen in the pause_option field.\nFor non-renewing subscriptions, pause_date should be before the cancellation date.
Applicable when unbilled charges are present for the subscription and pause_option is set as immediately. Note: On the invoice raised, an automatic charge is attempted on the payment method available, if customer's auto-collection property is set to on.
Invoice charges\nIf 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.
Retain as unbilled\nIf no_action is chosen, charges are added to the resumption invoice.
Handles dunning for invoices already in the dunning cycle when a subscription is paused. Applicable when pause_option is set as immediately.\nIf invoice is in the dunning cycle, invoice_dunning_handing allows you to stop or continue dunning.
Continue dunning
\n* stop -Stop dunning
", "enum" : [ "continue", "stop" ], "example" : null }, "skip_billing_cycles" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The number of subscription billing cycles that will be skipped. The subscription resumes after the set number of billing cycles have been skipped. This is applicable only when the value of of pause_option\nis billing_cycles\n.
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.
Resource object representing subscription
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" }, "invoice" : { "$ref" : "#/components/schemas/Invoice", "description" : "Resource object representing invoice
" }, "unbilled_charges" : { "type" : "array", "description" : "Resource object representing unbilled_charge
", "items" : { "$ref" : "#/components/schemas/UnbilledCharge", "description" : "Resource object representing unbilled_charge" }, "example" : null }, "credit_notes" : { "type" : "array", "description" : "Resource object representing credit_note
", "items" : { "$ref" : "#/components/schemas/CreditNote", "description" : "Resource object representing credit_note" }, "example" : null } }, "required" : [ "customer", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/scheduled_changes" : { "get" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "subscription-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/subscription-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "subscription_scheduled_change" : { "$ref" : "#/components/schemas/SubscriptionScheduledChange", "description" : "Resource object representing subscription_scheduled_change" } }, "required" : [ "subscription_scheduled_change" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/update_scheduled_changes" : { "post" : { "summary" : "Update_scheduled_changes a subscription_scheduled_change", "operationId" : "update_scheduled_changes_a_subscription_scheduled_change", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "subscription-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/subscription-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "cancel_reason_code" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "action_type" : { "type" : "string", "deprecated" : false, "enum" : [ "cancel", "pause", "reactivate" ], "example" : null } }, "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "subscription_scheduled_change" : { "$ref" : "#/components/schemas/SubscriptionScheduledChange", "description" : "Resource object representing subscription_scheduled_change" } }, "required" : [ "subscription_scheduled_change" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/delete" : { "post" : { "summary" : "Delete a customer", "description" : "Deletes a particular customer identified by the a unique identifier. \nThis will delete the Payment Method from the gateway/vault. If you do not want the Payment Method to be deleted from the vault, set the value for the delete_payment_method parameter to false.\nThis operation is irreversible - all data related to the customer, such as subscriptions, invoices, transactions, and reports, will be deleted.\n**Note:** This operation schedules the customer resource for deletion. It will be deleted in a few minutes.\n", "operationId" : "delete_a_customer", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" } }, "required" : [ "customer" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/relationships" : { "post" : { "summary" : "Link a customer to an account hierarchy", "description" : "Establish a hierarchical relationship between customers. The path parameter customer_id identifies the child in this relationship.
Prerequisite\nBoth parent and child customers must be part of the same business entity.
Note
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. However, if the payment_owner_id is the same as the child's ID ({customer_id}), the "parent" is identified by parent_id.
ID of the customer intended to be set as the immediate parent of the customer identified by customer_id\n.
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.
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.
Decides if Chargebee should apply settings from the Chargebee Billing UI or from this API request.
\ntrue: Chargebee uses settings configured in the Chargebee Billing UI.false: Settings provided in the parent_account_access and child_account_access parameters are applied.If set to true\n, the parent receives email notifications for the child's subscriptions.
If set to true\n, the parent receives email notifications for payment-related activities on the child's invoices.
If set to true\n, the parent receives email notifications for the child's invoices.
If set to true\n, the child account receives email notifications for its subscriptions.
If set to true\n, the child account receives email notifications for payment-related activities for its invoices.
If set to true\n, the child account receives email notifications for its invoices.
Resource object representing customer
" } }, "required" : [ "customer" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/delete_relationship" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "customer" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/delete_contact" : { "post" : { "summary" : "Delete contacts for a customer", "description" : "Deletes a particular contact for a customer. You can delete a contact by giving the Contact ID as the input parameter.\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" } }, "required" : [ "customer" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/assign_payment_role" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\\* backup -\n\nBackup\n\\* none -\n\nNone\n\\* primary -\n\nPrimary\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
" }, "payment_source" : { "$ref" : "#/components/schemas/PaymentSource", "description" : "Resource object representing payment_source
" } }, "required" : [ "customer", "payment_source" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/move" : { "post" : { "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.
Prerequisites
preferred_currency_code must be enabled in the destination site.Resource object representing resource_migration
" } }, "required" : [ "resource_migration" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/hierarchy" : { "get" : { "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}
Retrieve all nodes in the account hierarchy.
\n* subordinates -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.
Retrieve nodes from the specified customer (identified by {customer_id}\n) to the root of its account hierarchy.
Resource object representing hierarchy
", "items" : { "$ref" : "#/components/schemas/Hierarchy", "description" : "Resource object representing hierarchy" }, "example" : null } }, "required" : [ "hierarchies" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/update_payment_method" : { "post" : { "summary" : "Update payment method for a customer", "description" : "Payment Sources\ncomes with additional options and improvements to the Card APIs\n. For this operation, use the Create using temporary token\nAPI or Create using permanent token\nAPI under Payment Sources to update payment method for the customer.
Updates payment method details for a customer.
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\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.
PayPal Express Checkout\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.
Login and Pay with Amazon\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.
Card Payments\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
type as card.gateway with the gateway associated with the card. If the gateway is not specified, the default gateway will be used.reference_id with the identifier provided by the gateway/Spreedly to reference that specific card.Reference id format for Card Payments\nThe format of reference_id will differ based on where the card is stored.
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.
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(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.
Spreedly Card vault: If the card details are stored in Spreedly vault, then you need to provide the Spreedly token as reference_id.
Direct Debit Payments\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
type as direct_debit.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.reference_id with the identifier provided by the gateway to reference the customer's bank account details.tmp_token with the single use token provided by the gateway ( Should be passed only if reference_id is not passed ).Reference id format for Direct Debit Payments\nThe format of reference_id will differ based on where the bank account is stored.
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(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.
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.
GoCardless: The reference_id is the GoCardless Customer Mandate ID (e.g. MD0077Z99TTQXK).
Note: While using this API to update payment method details, Card Verification will not happen even if it is enabled for that particular gateway.
ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nIf you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, then XI\n(the code for United Kingdom - Northern Ireland\n) is available as an option.
checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_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.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's deviceResource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" } }, "required" : [ "customer" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}" : { "get" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" } }, "required" : [ "customer" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] }, "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\\* on -\n\nWhenever an invoice is created, an automatic attempt to charge the customer's payment method is made.\n\\* off -\n\nAutomatic 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* taxable -Computes tax for the customer based on the site configuration.\nIn 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 -entity_code or exempt_number attributes if you use Chargebee's AvaTax for Sales or specify exemption_details attribute if you use Chargebee's AvaTax for Communications 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.Indicates whether invoices raised on the same day for the customer are consolidated. When provided, this overrides the default configuration at the site-level. This parameter can be provided only when Consolidated Invoicing is enabled.
Note:
Any invoices raised when a subscription activates from in_trial or future status, are not consolidated by default. Contact Support to enable consolidation for such invoices.
.
", "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
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" } }, "required" : [ "customer" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/hierarchy_detail" : { "get" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "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.
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.
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.
For example, the renewals happen on 15th July when billing_month is 7 and billing_date is 15.
Note\nApplicable when Calendar Billing (with customer-specific billing date support) is enabled and billing_date_mode is manually_set.
Resource object representing customer
" } }, "required" : [ "customer" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers" : { "get" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "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.
entity_code or exempt_number attributes if you use Chargebee’s AvaTax for Sales or specify exemption_details attribute if you use Chargebee’s AvaTax for Communications 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.entity_code or exempt_number attributes if you use Chargebee’s AvaTax for Sales or specify exemption_details attribute if you use Chargebee’s AvaTax for Communications 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.entity_code or exempt_number attributes if you use Chargebee’s AvaTax for Sales or specify exemption_details attribute if you use Chargebee’s AvaTax for Communications 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.entity_code or exempt_number attributes if you use Chargebee’s AvaTax for Sales or specify exemption_details attribute if you use Chargebee’s AvaTax for Communications 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.optional, timestamp(UTC) in seconds filter
\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.\nSupported operators :\nafter, before, on, between
Example →\nupdated_at[on] = "1243545465"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "1243545465", "properties" : { "after" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "before" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "on" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[\\d{10},\\d{10}\\]$", "example" : null } } } }, { "name" : "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 \\* \\`cash\\` - Cash \\* \\`check\\` - Check \\* \\`bank_transfer\\` - Bank Transfer \\* \\`ach_credit\\` - ACH Credit \\* \\`sepa_credit\\` - SEPA Credit \\* \\`boleto\\` - Boleto \\* \\`us_automated_bank_transfer\\` - US Automated Bank Transfer \\* \\`eu_automated_bank_transfer\\` - EU Automated Bank Transfer \\* \\`uk_automated_bank_transfer\\` - UK Automated Bank Transfer \\* \\`jp_automated_bank_transfer\\` - JP Automated Bank Transfer \\* \\`mx_automated_bank_transfer\\` - MX Automated Bank Transfer \\* \\`custom\\` - Custom\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 }, "is_not" : { "type" : "string", "description" : "\\* \\`no_preference\\` - No Preference \\* \\`cash\\` - Cash \\* \\`check\\` - Check \\* \\`bank_transfer\\` - Bank Transfer \\* \\`ach_credit\\` - ACH Credit \\* \\`sepa_credit\\` - SEPA Credit \\* \\`boleto\\` - Boleto \\* \\`us_automated_bank_transfer\\` - US Automated Bank Transfer \\* \\`eu_automated_bank_transfer\\` - EU Automated Bank Transfer \\* \\`uk_automated_bank_transfer\\` - UK Automated Bank Transfer \\* \\`jp_automated_bank_transfer\\` - JP Automated Bank Transfer \\* \\`mx_automated_bank_transfer\\` - MX Automated Bank Transfer \\* \\`custom\\` - Custom\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 }, "in" : { "type" : "string", "description" : "\\* \\`no_preference\\` - No Preference \\* \\`cash\\` - Cash \\* \\`check\\` - Check \\* \\`bank_transfer\\` - Bank Transfer \\* \\`ach_credit\\` - ACH Credit \\* \\`sepa_credit\\` - SEPA Credit \\* \\`boleto\\` - Boleto \\* \\`us_automated_bank_transfer\\` - US Automated Bank Transfer \\* \\`eu_automated_bank_transfer\\` - EU Automated Bank Transfer \\* \\`uk_automated_bank_transfer\\` - UK Automated Bank Transfer \\* \\`jp_automated_bank_transfer\\` - JP Automated Bank Transfer \\* \\`mx_automated_bank_transfer\\` - MX Automated Bank Transfer \\* \\`custom\\` - Custom\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" ], "pattern" : "^\\[(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom)(,(no_preference|cash|check|bank_transfer|ach_credit|sepa_credit|boleto|us_automated_bank_transfer|eu_automated_bank_transfer|uk_automated_bank_transfer|jp_automated_bank_transfer|mx_automated_bank_transfer|custom))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`no_preference\\` - No Preference \\* \\`cash\\` - Cash \\* \\`check\\` - Check \\* \\`bank_transfer\\` - Bank Transfer \\* \\`ach_credit\\` - ACH Credit \\* \\`sepa_credit\\` - SEPA Credit \\* \\`boleto\\` - Boleto \\* \\`us_automated_bank_transfer\\` - US Automated Bank Transfer \\* \\`eu_automated_bank_transfer\\` - EU Automated Bank Transfer \\* \\`uk_automated_bank_transfer\\` - UK Automated Bank Transfer \\* \\`jp_automated_bank_transfer\\` - JP Automated Bank Transfer \\* \\`mx_automated_bank_transfer\\` - MX Automated Bank Transfer \\* \\`custom\\` - Custom\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" ], "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. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "pattern" : "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "pattern" : "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\]$", "example" : null } } } }, { "name" : "business_entity_id", "in" : "query", "description" : "optional, string filter\n\nThe ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity. \n**Note**\n\n[Multiple Business Entities](/docs/api/getting-started) is a feature available only on Product Catalog 2.0.\n\n**Supported operators :**\nis, is_not, starts_with\n\n**Example →**\n*business_entity_id\\[is_not\\] = \"business_entity_id\"*\n", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "business_entity_id", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null } } } }, { "name" : "sort_by", "in" : "query", "description" : "optional, string filter\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.
Note:\nThis operation optionally supports 3DS verification flow. To achieve the same, create the Payment Intent\nand pass it as input parameter to this API.
Creates a customer. You can create a customer and then create subscriptions for the customer when required. When creating a customer, you can pass along the billing address and card details.
Passing raw card data via API involves PCI liability at your end due to the sensitivity of the data. Instead, you can use one of the following integration options as applicable:
Here's some resources you can use to collect card information within your checkout form based on the payment gateway you use:
adyen.encrypted.dataas temp token in this API.When 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.
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.
The VAT/tax registration number for the customer. For customers with billing_address
country\nas\nXI\n(which is United Kingdom - Northern Ireland\n), the first two characters of the full VAT number\ncan be overridden by setting\nvat_number_prefix\n.
An overridden value for the first two characters of the full VAT number.\nOnly applicable specifically for customers with billing_address
country\nas XI\n(which is United Kingdom - Northern Ireland\n).
When you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, you have the option of setting billing_address
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\nXI\nby default. However, if the VAT number was registered in UK, the value should be GB.\nSet\nvat_number_prefix\nto GB\nfor such cases.
The Peppol BIS scheme associated with the 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\n.
Tip:
If there are additional entity identifiers for the customer not associated with the vat_number, they can be provided as the entity_identifiers[] array.
The standard used for specifying the entity_identifier_scheme.\nCurrently only iso6523-actorid-upis\nis supported and is used by default when not provided.
Tip:
If there are additional entity identifiers for the customer not associated with the vat_number, they can be provided as the entity_identifiers[] array.
Confirms that a customer is registered under GST. If set to true\nthen the Reverse Charge Mechanism\nis applicable. This field is applicable only when Australian GST is configured for your site.
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.
Tip:
It is possible to set a value for this flag even when E-Invoicing is disabled. However, it comes into effect only when E-Invoicing is enabled.
Specifies if the customer is liable for tax.
\n* taxable -Computes tax for the customer based on the site configuration.\nIn 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 -entity_code or exempt_number attributes if you use Chargebee's AvaTax for Sales or specify exemption_details attribute if you use Chargebee's AvaTax for Communications 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.Indicates whether invoices raised on the same day for the customer are consolidated. When provided, this overrides the default configuration at the site-level. This parameter can be provided only when Consolidated Invoicing is enabled.
Note:
Any invoices raised when a subscription activates from in_trial or future status, are not consolidated by default. Contact Support to enable consolidation for such invoices.
.
", "example" : null }, "token_id" : { "type" : "string", "deprecated" : false, "description" : "The Chargebee payment token generated by Chargebee JS.
\nNote:\nThe payment token created via Chargebee JS uses the gateway selected through Smart Routing.\nExplicitly passing a gateway_id\nin this API call will not override the gateway associated with the token.
The ISO 3166-2 state/province 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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if billing_state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_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.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's deviceThe billing address associated with the bank account. The value is a JSON object with the following keys and their values:- first_name:(string, max chars=150) The first name of the contact.
last_name:(string, max chars=150) The last name of the contact.company_name:(string, max chars=250) The company name for the address.line1:(string, max chars=180) The first line of the address.line2:(string, max chars=180) The second line of the address.country:(string) The name of the country for the address.country_code:(string, max chars=50) The two-letter, ISO 3166 alpha-2 country code for the address.state:(string, max chars=50) The name of the state or province for the address. When not provided, this is set automatically for US, Canada, India, and UAE.state_code:(string, max chars=50) The ISO 3166-2 state/province code without the country prefix. This is supported for USA, Canada, India, and UAE. For instance, for Arizona (USA), set state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC). For Dubai (UAE), set as DU (not AE-DU).city:(string, max chars=50) The city name for the address.postal_code:(string, max chars=20) The postal or ZIP code for the address.phone:(string, max chars=50) The contact phone number for the address.email:(string, max chars=70) The contact email address for the address.ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nIf you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, then XI\n(the code for United Kingdom - Northern Ireland\n) is available as an option.
checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_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.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's devicecheckout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_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.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's deviceThe ISO 3166-2 state/province 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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The unique id for the entity_identifier\nin Chargebee. When not provided, it is autogenerated.
The Peppol BIS scheme associated with the 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\n.
Tip:
If there is only one entity identifier for the customer and the value is the same as vat_number, then there is no need to provide the entity_identifiers[] array. See description for entity_identifiers[].
The value of the entity_identifier.\nThis identifies the customer entity on the Peppol network. For example: 10101010-STO-10\n.
Tip:
If there is only one entity identifier for the customer and the value is the same as vat_number, then there is no need to provide the entity_identifiers[] array. See description for entity_identifiers[].
The standard used for specifying the entity_identifier\nscheme.\nCurrently, only iso6523-actorid-upis\nis supported and is used by default when not provided.
Tip:
If there is only one entity identifier for the customer and the value is the same as vat_number, then there is no need to provide the entity_identifiers[] array. See description for entity_identifiers[].
Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" } }, "required" : [ "customer" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/add_contact" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" } }, "required" : [ "customer" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/contacts" : { "get" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "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.
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.
Resource object representing customer
" } }, "required" : [ "customer" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/merge" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "customer" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/collect_payment" : { "post" : { "summary" : "Collect payment for customer", "description" : "**Note:**\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\\* customer -\n\nPass this value to indicate that the request is initiated by the customer\n\\* merchant -\n\nPass 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\\* grab_pay -\n\nPayments made via GrabPay\n\\* sepa_instant_transfer -\n\nPayments made via Sepa Instant Transfer\n\\* go_pay -\n\nPayments made via GoPay\n\\* dotpay -\n\nPayments made via Dotpay.\n\\* google_pay -\n\nPayments made via Google Pay.\n\\* klarna -\n\nPayments made via Klarna.\n\\* paypal_express_checkout -\n\nPayments made via PayPal Express Checkout.\n\\* after_pay -\n\nPayments made via Afterpay\n\\* ideal -\n\nPayments made via iDEAL.\n\\* pix -\n\nPayments made via Pix\n\\* pay_by_bank -\n\nPay By Bank\n\\* sofort -\n\nPayments made via Sofort.\n\\* twint -\n\nPayments made via Twint\n\\* electronic_payment_standard -\n\nElectronic Payment Standard\n\\* generic -\n\nPayments made via Generic Payment Method.\n\\* klarna_pay_now -\n\nPayments made via Klarna Pay Now\n\\* netbanking_emandates -\n\nNetbanking (eMandates) Payments.\n\\* apple_pay -\n\nPayments made via Apple Pay.\n\\* unionpay -\n\nPayments made via UnionPay.\n\\* faster_payments -\n\nPayments made via Faster Payments\n\\* swish -\n\nPayments made via Swish\n\\* venmo -\n\nPayments made via Venmo\n\\* giropay -\n\nPayments made via giropay.\n\\* payconiq_by_bancontact -\n\nPayments made via Payconiq by Bancontact.\n\\* naver_pay -\n\nPayments made via Naver Pay.\n\\* direct_debit -\n\nRepresents bank account for which the direct debit or ACH agreement/mandate is created.\n\\* paypay - \\* south_korean_cards - \\* bancontact -\n\nPayments made via Bancontact Card.\n\\* automated_bank_transfer -\n\nRepresents virtual bank account using which the payment will be done.\n\\* upi -\n\nUPI Payments.\n\\* revolut_pay -\n\nPayments made via Revolut Pay.\n\\* amazon_payments -\n\nPayments made via Amazon Payments.\n\\* gcash - \\* card -\n\nCard based payment including credit cards and debit cards. Details about the card can be obtained from the card resource.\n\\* stablecoin -\n\nPayments made via Stablecoin.\n\\* alipay -\n\nPayments made via Alipay. \nThis payment source is deprecated.\n\\* payme -\n\nPayments made via PayMe\n\\* online_banking_poland - \\* pay_to -\n\nPayments made via PayTo\n\\* pay_co -\n\nPayments made via PayCo\n\\* trustly -\n\nTrustly\n\\* kbc_payment_button -\n\nKBC Payment Button\n\\* kakao_pay -\n\nPayments made via Kakao Pay.\n\\* alipay_hk - \\* wechat_pay -\n\nPayments made via WeChat Pay. \nThis payment source is deprecated.\n\\* cash_app_pay -\n\nPayments made via Cash App Pay.\n", "enum" : [ "card", "paypal_express_checkout", "amazon_payments", "direct_debit", "generic", "alipay", "unionpay", "apple_pay", "wechat_pay", "ideal", "google_pay", "sofort", "bancontact", "giropay", "dotpay", "upi", "netbanking_emandates", "venmo", "pay_to", "faster_payments", "sepa_instant_transfer", "automated_bank_transfer", "klarna_pay_now", "online_banking_poland", "payconiq_by_bancontact", "electronic_payment_standard", "kbc_payment_button", "pay_by_bank", "trustly", "stablecoin", "kakao_pay", "naver_pay", "revolut_pay", "cash_app_pay", "twint", "go_pay", "grab_pay", "pay_co", "after_pay", "swish", "payme", "pix", "klarna", "alipay_hk", "paypay", "gcash", "south_korean_cards", "paynow", "bizum", "promptpay", "dana", "touch_n_go", "tamara", "qpay" ], "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 or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_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.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's deviceThe ISO 3166-2 state/province 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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if billing_state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_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.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's devicecheckout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_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.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's deviceResource object representing customer
" }, "transaction" : { "$ref" : "#/components/schemas/Transaction", "description" : "Resource object representing transaction
" } }, "required" : [ "customer", "transaction" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/record_excess_payment" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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" : "", "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\\* cash -\n\nCash\n\\* other -\n\nPayment Methods other than the above types\n\\* custom -\n\nCustom\n\\* check -\n\nCheck\n\\* bank_transfer -\n\nBank Transfer\n", "enum" : [ "cash", "check", "bank_transfer", "other", "custom", "dana", "touch_n_go", "tamara", "qpay" ], "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
" }, "transaction" : { "$ref" : "#/components/schemas/Transaction", "description" : "Resource object representing transaction
" } }, "required" : [ "customer", "transaction" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/update_contact" : { "post" : { "summary" : "Update contacts for a customer", "description" : "Updates the details of a contact for a customer. You can give the field data to be updated as input parameters along with the Contact ID to update it.\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" } }, "required" : [ "customer" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/update_hierarchy_settings" : { "post" : { "summary" : "Update account hierarchy access settings for a customer", "description" : "When the customer is part of an account hierarchy, this operation updates the access privileges that both the customer and its parent have to the customer's data.
Terminology\nThe term "parent" usually refers to the customer with the ID 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.
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 and then call Link a customer with the updated values.
Decides if Chargebee should apply settings from the Chargebee Billing UI or from this API request.
\ntrue: 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.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.If true\n, the parent account will receive subscription-related emails sent to the child account.
If true\n, the parent account will receive payment-related emails sent to the child account.
If true\n, the parent account will receive invoice-related emails sent to the child account.
If true\n, the child account receives email notifications for its subscriptions.
If true\n, the child account receives email notifications for payment-related activities for its invoices.
If true\n, the child account receives email notifications for its invoices.
Resource object representing customer
" } }, "required" : [ "customer" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/update_billing_info" : { "post" : { "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.
During 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.
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.
The VAT/tax registration number for the customer. For customers with billing_address
country\nas\nXI\n(which is United Kingdom - Northern Ireland\n), the first two characters of the full VAT number\ncan be overridden by setting\nvat_number_prefix\n.
An overridden value for the first two characters of the full VAT number.\nOnly applicable specifically for customers with billing_address
country\nas XI\n(which is United Kingdom - Northern Ireland\n).
When you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, you have the option of setting billing_address
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\nXI\nby default. However, if the VAT number was registered in UK, the value should be GB.\nSet\nvat_number_prefix\nto GB\nfor such cases.
The Peppol BIS scheme associated with the 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\n.
Tip:
If there are additional entity identifiers for the customer not associated with the vat_number, they can be provided as the entity_identifiers[] array.
The standard used for specifying the entity_identifier_scheme.\nCurrently only iso6523-actorid-upis\nis supported and is used by default when not provided.
Tip:
If there are additional entity identifiers for the customer not associated with the vat_number, they can be provided as the entity_identifiers[] array.
Confirms that a customer is registered under GST. If set to true\nthen the Reverse Charge Mechanism\nis applicable. This field is applicable only when Australian GST is configured for your site.
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.
Tip:
It is possible to set a value for this flag even when E-Invoicing is disabled. However, it comes into effect only when E-Invoicing is enabled.
The ISO 3166-2 state/province 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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
E-Invoicing
If 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.
The unique id for the entity_identifier[i]\nin Chargebee. This is required when entity_identifier[operation][i]\nis update\nor delete\n.
The Peppol BIS scheme associated with the 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\n.
Tip:
If there is only one entity identifier for the customer and the value is the same as vat_number, then there is no need to provide the entity_identifiers[] array. See description for entity_identifiers[].
The value of the entity_identifier.\nThis identifies the customer entity on the Peppol network. For example: 10101010-STO-10\n.
Tip:
If there is only one entity identifier for the customer and the value is the same as vat_number, then there is no need to provide the entity_identifiers[] array. See description for entity_identifiers[].
The operation to be performed for the entity_identifier\n.
Updates an existing entity_identifier\nfor the customer. entity_identifier[id]\nmust be provided in this case.
Deletes an existing entity_identifier\nfor the customer. entity_identifier[id]\nmust be provided in this case.
Creates a new entity_identifier\nfor the customer.
The standard used for specifying the entity_identifier\nscheme.\nCurrently, only iso6523-actorid-upis\nis supported and is used by default when not provided.
Tip:
If there is only one entity identifier for the customer and the value is the same as vat_number, then there is no need to provide the entity_identifiers[] array. See description for entity_identifiers[].
Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" } }, "required" : [ "customer" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/tokens/create_using_temp_token" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\\* google_pay -\n\nPayments made via Google Pay.\n\\* pay_co -\n\nPayments made via PayCo\n\\* apple_pay -\n\nPayments made via Apple Pay.\n\\* unionpay -\n\nPayments made via UnionPay.\n\\* ideal -\n\nPayments made via iDEAL.\n\\* amazon_payments -\n\nPayments made via Amazon Payments.\n\\* bancontact -\n\nPayments made via Bancontact Card.\n\\* electronic_payment_standard -\n\nElectronic Payment Standard\n\\* grab_pay -\n\nPayments made via GrabPay\n\\* netbanking_emandates -\n\nNetbanking (eMandates) Payments.\n\\* trustly -\n\nTrustly\n\\* after_pay -\n\nPayments made via Afterpay\n\\* alipay -\n\nPayments made via Alipay. \nThis payment source is deprecated.\n\\* card -\n\nCard based payment including credit cards and debit cards. Details about the card can be obtained from the card resource.\n\\* dotpay -\n\nPayments made via Dotpay.\n\\* giropay -\n\nPayments made via giropay.\n\\* upi -\n\nUPI Payments.\n\\* sofort -\n\nPayments made via Sofort.\n\\* pay_by_bank -\n\nPay By Bank\n\\* go_pay -\n\nPayments made via GoPay\n\\* swish -\n\nPayments made via Swish\n\\* direct_debit -\n\nRepresents bank account for which the direct debit or ACH agreement/mandate is created.\n\\* twint -\n\nPayments made via Twint\n\\* generic -\n\nPayments made via Generic Payment Method.\n\\* payme -\n\nPayments made via PayMe\n\\* wechat_pay -\n\nPayments made via WeChat Pay. \nThis payment source is deprecated.\n\\* paypal_express_checkout -\n\nPayments made via PayPal Express Checkout.\n\\* kbc_payment_button -\n\nKBC Payment Button\n", "enum" : [ "card", "paypal_express_checkout", "amazon_payments", "direct_debit", "generic", "alipay", "unionpay", "apple_pay", "wechat_pay", "ideal", "google_pay", "sofort", "bancontact", "giropay", "dotpay", "upi", "netbanking_emandates", "venmo", "pay_to", "faster_payments", "sepa_instant_transfer", "automated_bank_transfer", "klarna_pay_now", "online_banking_poland", "payconiq_by_bancontact", "electronic_payment_standard", "kbc_payment_button", "pay_by_bank", "trustly", "stablecoin", "kakao_pay", "naver_pay", "revolut_pay", "cash_app_pay", "twint", "go_pay", "grab_pay", "pay_co", "after_pay", "swish", "payme", "pix", "klarna", "alipay_hk", "paypay", "gcash", "south_korean_cards", "paynow", "bizum", "promptpay", "dana", "touch_n_go", "tamara", "qpay" ], "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 or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_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.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device\n.The ISO 3166-2 state/province 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).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
Resource object representing token
" } }, "required" : [ "token" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/tokens/create_for_card" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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 only supported for Stripe.\n\\* cartes_bancaires -\n\nA Cartes Bancaires card scheme.\n\\* mastercard -\n\nA MasterCard scheme.\n\\* mada -\n\nA Mada card scheme.\n\\* visa -\n\nA Visa card scheme.\n", "enum" : [ "cartes_bancaires", "mastercard", "visa" ], "example" : null }, "billing_addr1" : { "type" : "string", "deprecated" : false, "description" : "Address line 1, as available in card billing address.\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\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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if billing_state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_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.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's deviceResource object representing token
" } }, "required" : [ "token" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/tokens/{cb-token-id}" : { "get" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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
" } }, "required" : [ "token" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/payment_sources/create_using_permanent_token" : { "post" : { "summary" : "Create using permanent token", "description" : "This API provides an alternative way to create a payment source using a permanent token, instead of having to add the full payment method details via API or the Chargebee UI. Permanent tokens are provided by payment gateways such as Stripe. \nStoring card after successful 3DS completion is not supported in this API. Use [create using Payment Intent API](/docs/api/payment_sources/create-using-payment-intent)\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\\* direct_debit -\n\nRepresents bank account for which the direct debit or ACH agreement/mandate is created.\n\\* unionpay -\n\nPayments made via UnionPay.\n\\* google_pay -\n\nPayments made via Google Pay.\n\\* sepa_instant_transfer -\n\nPayments made via Sepa Instant Transfer\n\\* dotpay -\n\nPayments made via Dotpay.\n\\* pay_to -\n\nPayments made via PayTo\n\\* klarna -\n\nPayments made via Klarna.\n\\* revolut_pay -\n\nPayments made via Revolut Pay.\n\\* naver_pay -\n\nPayments made via Naver Pay.\n\\* giropay -\n\nPayments made via giropay.\n\\* grab_pay -\n\nPayments made via GrabPay\n\\* stablecoin -\n\nPayments made via Stablecoin.\n\\* alipay -\n\nPayments made via Alipay. \nThis payment source is deprecated.\n\\* kakao_pay -\n\nPayments made via Kakao Pay.\n\\* sofort -\n\nPayments made via Sofort.\n\\* pix -\n\nPayments made via Pix\n\\* gcash - \\* pay_co -\n\nPayments made via PayCo\n\\* wechat_pay -\n\nPayments made via WeChat Pay. \nThis payment source is deprecated.\n\\* netbanking_emandates -\n\nNetbanking (eMandates) Payments.\n\\* bancontact -\n\nPayments made via Bancontact Card.\n\\* go_pay -\n\nPayments made via GoPay\n\\* card -\n\nCard based payment including credit cards and debit cards. Details about the card can be obtained from the card resource.\n\\* amazon_payments -\n\nPayments made via Amazon Payments.\n\\* pay_by_bank -\n\nPay By Bank\n\\* online_banking_poland - \\* after_pay -\n\nPayments made via Afterpay\n\\* faster_payments -\n\nPayments made via Faster Payments\n\\* alipay_hk - \\* paypay - \\* generic -\n\nPayments made via Generic Payment Method.\n\\* payme -\n\nPayments made via PayMe\n\\* klarna_pay_now -\n\nPayments made via Klarna Pay Now\n\\* twint -\n\nPayments made via Twint\n\\* swish -\n\nPayments made via Swish\n\\* automated_bank_transfer -\n\nRepresents virtual bank account using which the payment will be done.\n\\* paypal_express_checkout -\n\nPayments made via PayPal Express Checkout.\n\\* venmo -\n\nPayments made via Venmo\n\\* ideal -\n\nPayments made via iDEAL.\n\\* trustly -\n\nTrustly\n\\* upi -\n\nUPI Payments.\n\\* kbc_payment_button -\n\nKBC Payment Button\n\\* cash_app_pay -\n\nPayments made via Cash App Pay.\n\\* payconiq_by_bancontact -\n\nPayments made via Payconiq by Bancontact.\n\\* south_korean_cards - \\* apple_pay -\n\nPayments made via Apple Pay.\n\\* electronic_payment_standard -\n\nElectronic Payment Standard\n", "enum" : [ "card", "paypal_express_checkout", "amazon_payments", "direct_debit", "generic", "alipay", "unionpay", "apple_pay", "wechat_pay", "ideal", "google_pay", "sofort", "bancontact", "giropay", "dotpay", "upi", "netbanking_emandates", "venmo", "pay_to", "faster_payments", "sepa_instant_transfer", "automated_bank_transfer", "klarna_pay_now", "online_banking_poland", "payconiq_by_bancontact", "electronic_payment_standard", "kbc_payment_button", "pay_by_bank", "trustly", "stablecoin", "kakao_pay", "naver_pay", "revolut_pay", "cash_app_pay", "twint", "go_pay", "grab_pay", "pay_co", "after_pay", "swish", "payme", "pix", "klarna", "alipay_hk", "paypay", "gcash", "south_korean_cards", "paynow", "bizum", "promptpay", "dana", "touch_n_go", "tamara", "qpay" ], "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.
Note:
This is not the one-time temporary token provided by gateways like Stripe.
\nreference_id is an alternative for payment_method_token, customer_profile_token, network_transaction_id, or mandate_id.
payment_method_token, customer_profile_token, network_transaction_id, or mandate_id cannot be used with reference_id.
reference_id is a combination of multiple tokens available at the gateway. Learn more about the combination of each gateway from this document.
An identifier provided by the gateway or card vault for the specific payment method resource.
\nNote:\npayment_method_token is an alternative for reference_id and cannot be used with reference_id.
A unique identifier associated with a customer`s profile within a payment gateway.
\nNote:\ncustomer_profile_token is an alternative for reference_id and cannot be used with reference_id.
An identifier of the payment or authorization transaction at the gateway initiated using this payment method.
\nNote:\nnetwork_transaction_id is an alternative for reference_id and cannot be used with reference_id.
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.
\nNote:\nmandate_id is an alternative for reference_id and cannot be used with reference_id.
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.\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.
Note:\nCurrently, the skip_retrieval value as true is only supported for the Vantiv payment gateway.
checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_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.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device\n.The ISO 3166-2 state/province 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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
Resource object representing customer
" }, "payment_source" : { "$ref" : "#/components/schemas/PaymentSource", "description" : "Resource object representing payment_source
" } }, "required" : [ "customer", "payment_source" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/payment_sources/{cust-payment-source-id}/delete" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" }, "payment_source" : { "$ref" : "#/components/schemas/PaymentSource", "description" : "Resource object representing payment_source
" } }, "required" : [ "customer", "payment_source" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/payment_sources/create_card" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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 only supported for Stripe.\n\\* mastercard -\n\nA MasterCard scheme.\n\\* cartes_bancaires -\n\nA Cartes Bancaires card scheme.\n\\* visa -\n\nA Visa card scheme.\n", "enum" : [ "cartes_bancaires", "mastercard", "visa" ], "example" : null }, "billing_addr1" : { "type" : "string", "deprecated" : false, "description" : "Address line 1, as available in card billing address.\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\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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if billing_state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_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.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's deviceResource object representing customer
" }, "payment_source" : { "$ref" : "#/components/schemas/PaymentSource", "description" : "Resource object representing payment_source
" } }, "required" : [ "customer", "payment_source" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/payment_sources/{cust-payment-source-id}/verify_bank_account" : { "post" : { "summary" : "Verify bank account payment source", "description" : "This API can be used to verify bank accounts which have been added as payment source. This is applicable for **Stripe ACH with micro-deposit mode bank accounts** only. Stripe handles verification in two ways - via Plaid, and micro-deposit.\n\nFor verifying bank accounts via **micro-deposit**, Stripe deposits two small amounts to the bank account being added. These deposits will take 1-2 business days to appear on the customer's bank statement. The bank statement description for the two micro-deposits contains the amount and the values deposited. Your customer will need to relay the value of the two deposits to you, after which you can verify the bank account. Once the bank account has been verified, the payment source will be marked as \"Valid\". \nA maximum of 10 failed verification attempts are allowed. Once this limit has been crossed, the bank account can no longer be verified, and will be marked as \"Invalid\" in Chargebee.\n", "operationId" : "verify_bank_account_payment_source", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "payment_source" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/payment_sources" : { "get" : { "summary" : "List payment sources", "description" : "Lists all the payment sources\n", "operationId" : "list_payment_sources", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "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.
Unique subscription identifier that helps to retrieve the payment source of a subscription which has mandate\nassociated to it.
Indicates whether to include deleted objects in the list. The deleted objects have the attribute 'deleted\n' as 'true\n'.
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.
Resource object representing third_party_payment_method
" } }, "required" : [ "third_party_payment_method" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/payment_sources/create_using_payment_intent" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\\* alipay_hk - \\* card -\n\ncard\n\\* twint -\n\nPayments made via Twint\n\\* swish -\n\nPayments made via Swish\n\\* after_pay -\n\nPayments made via Afterpay\n\\* netbanking_emandates -\n\nnetbanking_emandates\n\\* grab_pay -\n\nPayments made via GrabPay\n\\* paypay - \\* payconiq_by_bancontact -\n\nPayments made via Payconiq by Bancontact.\n\\* dotpay -\n\ndotpay\n\\* faster_payments -\n\nFaster Payments\n\\* upi -\n\nupi\n\\* kbc_payment_button -\n\nKBC Payment Button\n\\* electronic_payment_standard -\n\nElectronic Payment Standard\n\\* klarna -\n\nPayments made via Klarna.\n\\* payme -\n\nPayments made via PayMe\n\\* direct_debit -\n\ndirect_debit\n\\* sepa_instant_transfer -\n\nSepa Instant Transfer\n\\* bancontact -\n\nbancontact\n\\* go_pay -\n\nPayments made via GoPay\n\\* pay_by_bank -\n\nPay By Bank\n\\* google_pay -\n\ngoogle_pay\n\\* apple_pay -\n\napple_pay\n\\* online_banking_poland - \\* trustly -\n\nTrustly\n\\* gcash - \\* naver_pay -\n\nPayments made via Naver Pay.\n\\* stablecoin -\n\nPayments made via Stablecoin.\n\\* giropay -\n\ngiropay\n\\* paypal_express_checkout -\n\npaypal_express_checkout\n\\* pix -\n\nPix\n\\* venmo -\n\nVenmo\n\\* klarna_pay_now -\n\nKlarna Pay Now\n\\* alipay -\n\nPayments made via Alipay.\n\\* sofort -\n\nsofort\n\\* amazon_payments -\n\nAmazon Payments\n\\* ideal -\n\nideal\n\\* kakao_pay -\n\nPayments made via Kakao Pay.\n\\* pay_to -\n\nPayTo\n\\* south_korean_cards - \\* boleto -\n\nboleto\n\\* pay_co -\n\nPayments made via PayCo\n\\* revolut_pay -\n\nPayments made via Revolut Pay.\n\\* wechat_pay -\n\nPayments made via WeChat Pay.\n\\* cash_app_pay -\n\nPayments made via Cash App 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" ], "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.\nPass a stringified JSON containing the device_session_id\nand fraud_merchant_id\nas an input to fingerprint.\nHere's a sample\nto it.
checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_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.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's deviceResource object representing customer
" }, "payment_source" : { "$ref" : "#/components/schemas/PaymentSource", "description" : "Resource object representing payment_source
" } }, "required" : [ "customer", "payment_source" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/payment_sources/{cust-payment-source-id}" : { "get" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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
" } }, "required" : [ "payment_source" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/payment_sources/create_voucher_payment_source" : { "post" : { "summary" : "Create a voucher payment method", "description" : "Create a voucher payment method for the payment source.\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\\* boleto -\n\nBoleto\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.
last_name:(string, max chars=150) The last name of the contact.line1:(string, max chars=180) The first line of the address.line2:(string, max chars=180) The second line of the address.country_code:(string, max chars=50) The two-letter, ISO 3166 alpha-2 country code for the address.state_code:(string, max chars=50) The ISO 3166-2 state/province code without the country prefix.For instance, for Arizona (USA), set state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC).city:(string, max chars=50) The city name for the address.postal_code:(string, max chars=20) The postal or ZIP code for the address.phone:(string, max chars=50) The contact phone number for the address.email:(string, max chars=70) The contact email address for the address.Resource object representing customer
" }, "payment_source" : { "$ref" : "#/components/schemas/PaymentSource", "description" : "Resource object representing payment_source
" } }, "required" : [ "customer", "payment_source" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/payment_sources/create_using_temp_token" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\\* direct_debit -\n\nRepresents bank account for which the direct debit or ACH agreement/mandate is created.\n\\* unionpay -\n\nPayments made via UnionPay.\n\\* after_pay -\n\nPayments made via Afterpay\n\\* faster_payments -\n\nPayments made via Faster Payments\n\\* google_pay -\n\nPayments made via Google Pay.\n\\* alipay_hk - \\* sepa_instant_transfer -\n\nPayments made via Sepa Instant Transfer\n\\* dotpay -\n\nPayments made via Dotpay.\n\\* pay_to -\n\nPayments made via PayTo\n\\* klarna -\n\nPayments made via Klarna.\n\\* revolut_pay -\n\nPayments made via Revolut Pay.\n\\* naver_pay -\n\nPayments made via Naver Pay.\n\\* paypay - \\* generic -\n\nPayments made via Generic Payment Method.\n\\* payme -\n\nPayments made via PayMe\n\\* giropay -\n\nPayments made via giropay.\n\\* klarna_pay_now -\n\nPayments made via Klarna Pay Now\n\\* grab_pay -\n\nPayments made via GrabPay\n\\* twint -\n\nPayments made via Twint\n\\* swish -\n\nPayments made via Swish\n\\* automated_bank_transfer -\n\nRepresents virtual bank account using which the payment will be done.\n\\* stablecoin -\n\nPayments made via Stablecoin.\n\\* paypal_express_checkout -\n\nPayments made via PayPal Express Checkout.\n\\* alipay -\n\nPayments made via Alipay. \nThis payment source is deprecated.\n\\* venmo -\n\nPayments made via Venmo\n\\* kakao_pay -\n\nPayments made via Kakao Pay.\n\\* sofort -\n\nPayments made via Sofort.\n\\* pix -\n\nPayments made via Pix\n\\* gcash - \\* pay_co -\n\nPayments made via PayCo\n\\* wechat_pay -\n\nPayments made via WeChat Pay. \nThis payment source is deprecated.\n\\* ideal -\n\nPayments made via iDEAL.\n\\* trustly -\n\nTrustly\n\\* netbanking_emandates -\n\nNetbanking (eMandates) Payments.\n\\* upi -\n\nUPI Payments.\n\\* bancontact -\n\nPayments made via Bancontact Card.\n\\* go_pay -\n\nPayments made via GoPay\n\\* kbc_payment_button -\n\nKBC Payment Button\n\\* card -\n\nCard based payment including credit cards and debit cards. Details about the card can be obtained from the card resource.\n\\* cash_app_pay -\n\nPayments made via Cash App Pay.\n\\* payconiq_by_bancontact -\n\nPayments made via Payconiq using Bancontact.\n\\* amazon_payments -\n\nPayments made via Amazon Payments.\n\\* south_korean_cards - \\* pay_by_bank -\n\nPay By Bank\n\\* online_banking_poland - \\* apple_pay -\n\nPayments made via Apple Pay.\n\\* electronic_payment_standard -\n\nElectronic Payment Standard\n", "enum" : [ "card", "paypal_express_checkout", "amazon_payments", "direct_debit", "generic", "alipay", "unionpay", "apple_pay", "wechat_pay", "ideal", "google_pay", "sofort", "bancontact", "giropay", "dotpay", "upi", "netbanking_emandates", "venmo", "pay_to", "faster_payments", "sepa_instant_transfer", "automated_bank_transfer", "klarna_pay_now", "online_banking_poland", "payconiq_by_bancontact", "electronic_payment_standard", "kbc_payment_button", "pay_by_bank", "trustly", "stablecoin", "kakao_pay", "naver_pay", "revolut_pay", "cash_app_pay", "twint", "go_pay", "grab_pay", "pay_co", "after_pay", "swish", "payme", "pix", "klarna", "alipay_hk", "paypay", "gcash", "south_korean_cards", "paynow", "bizum", "promptpay", "dana", "touch_n_go", "tamara", "qpay" ], "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 or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_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.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device\n.Resource object representing customer
" }, "payment_source" : { "$ref" : "#/components/schemas/PaymentSource", "description" : "Resource object representing payment_source
" } }, "required" : [ "customer", "payment_source" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/payment_sources/{cust-payment-source-id}/update_card" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "cust-payment-source-id", "in" : "path", "required" : true, "deprecated" : false, "$ref" : "#/components/parameters/cust-payment-source-id", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "gateway_meta_data" : { "type" : "object", "additionalProperties" : true, "deprecated" : false, "description" : "Additional data about this resource can be passed to \\*\\*Stripe\\*\\* gateway here in the JSON Format. This will be stored along with payment source at the gateway account.\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\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).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
ebanx: While passing raw card details to EBANX, the user's document is required for some countries.
payer: User related information.\ndocument: Document is the user's identification number based on their country.Resource object representing customer
" }, "payment_source" : { "$ref" : "#/components/schemas/PaymentSource", "description" : "Resource object representing payment_source
" } }, "required" : [ "customer", "payment_source" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/payment_sources/{cust-payment-source-id}/switch_gateway_account" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" }, "payment_source" : { "$ref" : "#/components/schemas/PaymentSource", "description" : "Resource object representing payment_source
" } }, "required" : [ "customer", "payment_source" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/payment_sources/create_using_token" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" }, "payment_source" : { "$ref" : "#/components/schemas/PaymentSource", "description" : "Resource object representing payment_source
" } }, "required" : [ "customer", "payment_source" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/payment_sources/{cust-payment-source-id}/delete_local" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" }, "payment_source" : { "$ref" : "#/components/schemas/PaymentSource", "description" : "Resource object representing payment_source
" } }, "required" : [ "customer", "payment_source" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/payment_sources/create_bank_account" : { "post" : { "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.
ACH is an electronic network for passing financial transactions in the US. Chargebee currently supports ACH via Stripe , Authorize.Net, and GoCardless.
Note:
chargebee-request-origin-ip) and the device information(chargebee-request-origin-device).Once the bank account has been added, it needs to be verified.
SEPA is an initiative that integrates bank transfer payments denominated in euro. It is supported via GoCardless, Stripe and Adyen.
Note:
Bacs is an organization that manages the Direct Debit and Direct Credit payment methods in the UK. Bg Autogiro is a Direct Debit scheme for krona denominated payments in Sweden. Both Bacs and Bg Autogiro are supported via GoCardless.
Note:
chargebee-request-origin-ip) and the device information(chargebee-request-origin-device).BECS is an automated payment method for Direct Debit in Australia and New Zealand while PAD does the same for Canada. GoCardless supports both.
For Direct Debit, the customer needs to accept a mandate that allows the merchant to debit their bank account. This agreement PDF can be obtained using the Retrieve direct debit agreement PDF API.
If the customer has already reached the payment source limit allowed for the site, pass replace_primary_payment_source as true. Alternatively, delete one of the payment sources first and then add the bank account payment source for the customer.
Note:
chargebee-request-origin-ip) and the device information(chargebee-request-origin-device).The billing address associated with the bank account. The value is a JSON object with the following keys and their values:- first_name:(string, max chars=150) The first name of the contact.
last_name:(string, max chars=150) The last name of the contact.company_name:(string, max chars=250) The company name for the address.line1:(string, max chars=180) The first line of the address.line2:(string, max chars=180) The second line of the address.country:(string) The name of the country for the address.country_code:(string, max chars=50) The two-letter, ISO 3166 alpha-2 country code for the address.state:(string, max chars=50) The name of the state or province for the address. When not provided, this is set automatically for US, Canada, India, and UAE.state_code:(string, max chars=50) The ISO 3166-2 state/province code without the country prefix. This is supported for USA, Canada, India, and UAE. For instance, for Arizona (USA), set state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC). For Dubai (UAE), set as DU (not AE-DU).city:(string, max chars=50) The city name for the address.postal_code:(string, max chars=20) The postal or ZIP code for the address.phone:(string, max chars=50) The contact phone number for the address.email:(string, max chars=70) The contact email address for the address.Resource object representing customer
" }, "payment_source" : { "$ref" : "#/components/schemas/PaymentSource", "description" : "Resource object representing payment_source
" } }, "required" : [ "customer", "payment_source" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/payment_sources/{cust-payment-source-id}/update_bank_account" : { "post" : { "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.
The API is only supported for the payment_method of type direct_debit.
Resource object representing customer
" }, "payment_source" : { "$ref" : "#/components/schemas/PaymentSource", "description" : "Resource object representing payment_source
" } }, "required" : [ "customer", "payment_source" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/virtual_bank_accounts/{virtual-bank-account-id}/delete_local" : { "post" : { "summary" : "Local delete a virtual bank account", "description" : "Deletes virtual bank accounts from Chargebee. Payment method in the payment gateway, and Auto Collection settings in Chargebee are not affected.\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "virtual_bank_account" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/virtual_bank_accounts/{virtual-bank-account-id}/delete" : { "post" : { "summary" : "Delete a virtual bank account", "description" : "Deletes a virtual bank account. If there is no virtual bank account present in the gateway for the customer, this API will return successfully without throwing an error.\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "virtual_bank_account" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/virtual_bank_accounts" : { "get" : { "summary" : "List virtual bank accounts", "description" : "Lists all the virtual bank accounts.\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "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.
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.
Identifier of the gateway account to use when creating the virtual bank account.
\nDefault behavior\nWhen not provided, Chargebee selects an applicable gateway account for the chosen scheme. Selection follows your site's Smart Routing rules.
Type of the credit transfer.
\n* mx_automated_bank_transfer -MX Automated Bank Transfer
\n* sepa_credit -SEPA Credit Transfer
\nThis scheme is deprecated. Instead of sepa_credit\nuse eu_automated_bank_transfer\n.
EU Automated Bank Transfer
\n* ach_credit -ACH Credit Transfer
\nThis scheme is deprecated. Instead of ach_credit\nuse us_automated_bank_transfer\n.
JP Automated Bank Transfer
\n* us_automated_bank_transfer -US Automated Bank Transfer
\n* gb_automated_bank_transfer -UK Automated Bank Transfer
", "enum" : [ "ach_credit", "sepa_credit", "us_automated_bank_transfer", "gb_automated_bank_transfer", "eu_automated_bank_transfer", "jp_automated_bank_transfer", "mx_automated_bank_transfer" ], "example" : null } }, "required" : [ "customer_id" ], "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "virtual_bank_account" : { "$ref" : "#/components/schemas/VirtualBankAccount", "description" : "Resource object representing virtual_bank_account
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" } }, "required" : [ "virtual_bank_account" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/virtual_bank_accounts/{virtual-bank-account-id}" : { "get" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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
" } }, "required" : [ "virtual_bank_account" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/virtual_bank_accounts/create_using_permanent_token" : { "post" : { "summary" : "Create a virtual bank account using permanent token", "description" : "Creates a virtual bank account using the identifier provided by the gateway. \nCustomer's email and virtual bank accounts will always be in sync. Email ID specified for virtual bank account creation will be considered over customers' email ID.\n", "operationId" : "create_a_virtual_bank_account_using_permanent_token", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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.
\nDefault behavior\nWhen not provided, Chargebee selects an applicable gateway account for the chosen scheme. Selection follows your site's Smart Routing rules.
Type of the credit transfer.
\n* mx_automated_bank_transfer -MX Automated Bank Transfer
\n* sepa_credit -SEPA Credit Transfer
\nThis scheme is deprecated. Instead of sepa_credit\nuse eu_automated_bank_transfer\n.
EU Automated Bank Transfer
\n* ach_credit -ACH Credit Transfer
\nThis scheme is deprecated. Instead of ach_credit\nuse us_automated_bank_transfer\n.
JP Automated Bank Transfer
\n* us_automated_bank_transfer -US Automated Bank Transfer
\n* gb_automated_bank_transfer -UK Automated Bank Transfer
", "enum" : [ "ach_credit", "sepa_credit", "us_automated_bank_transfer", "gb_automated_bank_transfer", "eu_automated_bank_transfer", "jp_automated_bank_transfer", "mx_automated_bank_transfer" ], "example" : null } }, "required" : [ "customer_id", "reference_id" ], "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "virtual_bank_account" : { "$ref" : "#/components/schemas/VirtualBankAccount", "description" : "Resource object representing virtual_bank_account
" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" } }, "required" : [ "virtual_bank_account" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/copy_card" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "third_party_payment_method" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/cards/{customer-id}" : { "get" : { "summary" : "Retrieve card for a customer", "description" : "#### Deprecated\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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
" } }, "required" : [ "card" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/switch_gateway" : { "post" : { "summary" : "Switch gateway", "description" : "This request is obsoleted by the Switch gateway account API\nfor Payment Sources.
Switches the gateway in which customer's card information is stored. This is applicable only if the payment method is card.
Limitation
This request does not support switching between Braintree and Stripe payment gateways. Contact Chargebee Support\nto perform those actions.
Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" } }, "required" : [ "card", "customer" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/delete_card" : { "post" : { "summary" : "Delete card for a customer", "description" : "The Payment Sources API\n, with its additional options and improvements, obsoletes the Cards APIs. This request is obsoleted by the Delete a payment source API\n.
Deletes the card for a customer. Upon successful deletion the auto_collection attribute for the customer is set to off and a card_deleted event is triggered. If there is no card found at the gateway for the customer, this API returns without errors.
Resource object representing customer
" } }, "required" : [ "customer" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/credit_card" : { "post" : { "summary" : "Update card for a customer", "description" : "The Payment Sources API\n, with its additional options and improvements, obsoletes the Cards APIs\n. This operation is obsoleted by the following:
Adds or replaces card details of a customer. Updating card details replaces the present payment method.
Passing credit card details to this API involves PCI liability at your end as sensitive card info passes through your servers. If you wish to avoid that, you can use one of the following integration methodologies if applicable
Legacy behavior:
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 and the vat_number parameters each time you make this request, to avoid losing the same information at the customer-level.billing_address and vat_number of the customer.The ISO 3166-2 state/province 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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if billing_state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
.
", "maxLength" : 50, "example" : null } }, "required" : [ "expiry_month", "expiry_year", "number" ], "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "card" : { "$ref" : "#/components/schemas/Card", "description" : "Resource object representing card
" } }, "required" : [ "card", "customer" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/promotional_credits/{account-credit-id}" : { "get" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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
" } }, "required" : [ "promotional_credit" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/promotional_credits" : { "get" : { "summary" : "List promotional credits", "description" : "This endpoint lists the promotional credits set for a customer\n", "operationId" : "list_promotional_credits", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "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.
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.
Resource object representing customer
" }, "promotional_credit" : { "$ref" : "#/components/schemas/PromotionalCredit", "description" : "Resource object representing promotional_credit
" } }, "required" : [ "customer", "promotional_credit" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/promotional_credits/set" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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. \\\\\\* general - General \\\\\\* referral_rewards - Referral \\\\\\* 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
" }, "promotional_credit" : { "$ref" : "#/components/schemas/PromotionalCredit", "description" : "Resource object representing promotional_credit
" } }, "required" : [ "customer", "promotional_credit" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/promotional_credits/add" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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. \\\\\\* general - General \\\\\\* referral_rewards - Referral \\\\\\* 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
" }, "promotional_credit" : { "$ref" : "#/components/schemas/PromotionalCredit", "description" : "Resource object representing promotional_credit
" } }, "required" : [ "customer", "promotional_credit" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/delete_line_items" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/charge_addon" : { "post" : { "summary" : "Create invoice for a non-recurring addon", "description" : "Generate invoices for a non-recurring addon using this API.\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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.\ntaxes\nand\nline_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.
Resource object representing invoice
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/remove_credit_note" : { "post" : { "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.
Note:\nYou cannot remove a credit note from an invoice if it has already been refunded.
Resource object representing invoice
" }, "credit_note" : { "$ref" : "#/components/schemas/CreditNote", "description" : "Resource object representing credit_note
" } }, "required" : [ "credit_note", "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/remove_payment" : { "post" : { "summary" : "Remove payment from an invoice", "description" : "This API removes payments 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.
Resource object representing invoice
" }, "transaction" : { "$ref" : "#/components/schemas/Transaction", "description" : "Resource object representing transaction
" } }, "required" : [ "invoice", "transaction" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/stop_dunning" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/apply_payments" : { "post" : { "summary" : "Apply payments for an invoice", "description" : "The API applies excess payments to an invoice. Once an excess payment is applied, the invoice.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.
For example, if you have an excess payment of $25.00, and the invoice to which you want to apply this excess payment has a balance of $50. Once you apply this excess payment, the invoice status changes to paid, and invoice.amount_due is adjusted to $25.00.
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\n, or invoice.amount_due\n.
Resource object representing invoice
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/add_addon_charge" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/void" : { "post" : { "summary" : "Void an invoice", "description" : "Voids the specified invoice. Any payments must be removed from the invoice before voiding it.
proration enabled, no prorated credits are issued.Resource object representing invoice
" }, "credit_note" : { "$ref" : "#/components/schemas/CreditNote", "description" : "Resource object representing credit_note
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/add_charge" : { "post" : { "summary" : "Add one-time charge to a pending invoice", "description" : "Adds a one-time charge to a pending invoice. A one-time charge is a charge that is added ad hoc to the invoice and does not represent a predefined plan or addon. It appears in the invoice as a line_item of entity_type adhoc.
Resource object representing invoice
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/send_einvoice" : { "post" : { "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:
If e-invoicing is not enabled at the site and customer level.
\nIf there is an e-invoice generated already for the invoice.
\nIf the Use automatic e-invoicing option is selected.
\nIf there are no generated e-invoices with the failed or skipped status.
If the invoice status is voided or pending.
Resource object representing invoice
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/write_off" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" }, "credit_note" : { "$ref" : "#/components/schemas/CreditNote", "description" : "Resource object representing credit_note
" } }, "required" : [ "credit_note", "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/pause_dunning" : { "post" : { "summary" : "Pause dunning for invoice", "description" : "Pause dunning for the specified invoice until expected_payment_date. Chargebee cancels all configured payment collection retry attempts and dunning email notifications for the invoice until expected_payment_date.
This operation is only permitted for an invoice that meets all the following conditions:
payment_due.auto_collection set to on.Unless you resume dunning for the invoice, Chargebee attempts to collect payment on the expected_payment_date. If payment collection fails, the next action is taken as follows:
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.expected_payment_date is after the dunning period for the invoice, the final action configured in Billing is initiated for the invoice and, if applicable, for the subscription.Resource object representing invoice
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices" : { "get" : { "summary" : "List invoices", "description" : "Important\nFor sites where both legacy and latest 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.
Override options:
chargebee-response-schema-type: items → Return response in latest product catalog format only.chargebee-response-schema-type: plans_addons → Return response in legacy product catalog format only.Lists all the Invoices.
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.
status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.status when Metered Billing is enabled for the site.status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.status when Metered Billing is enabled for the site.status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.status when Metered Billing is enabled for the site.status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.status when Metered Billing is enabled for the site.optional, in cents filter
\nPayments collected successfully for the invoice. This is the sum of linked_payments[].txn_amount\nfor all linked_payments[]\nthat have txn_status\nas success.\nSupported operators :\nis, is_not, lt, lte, gt, gte, between
Example →\namount_paid[is] = "800"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "800", "properties" : { "is" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "is_not" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "lt" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "lte" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "gt" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "gte" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[-?\\d+,-?\\d+\\]$", "example" : null } } } }, { "name" : "amount_adjusted", "in" : "query", "description" : "optional, in cents filter\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
\nThe unpaid amount that is due on the invoice. This is calculated as: total
amount_paid\napplied_credits.applied_amountadjustment_credit_notes.cn_totallinked_taxes_withheld.amount.\nSupported operators :\nis, is_not, lt, lte, gt, gte, betweenExample →\namount_due[is_not] = "200"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "200", "properties" : { "is" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "is_not" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "lt" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "lte" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "gt" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "gte" : { "type" : "string", "format" : "number", "pattern" : "^-?\\d+$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[-?\\d+,-?\\d+\\]$", "example" : null } } } }, { "name" : "dunning_status", "in" : "query", "description" : "optional, enumerated string filter\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. \\* \\`exhausted\\` - Maximum number of attempts have been made. \\* \\`stopped\\` - Dunning has stopped for this invoice. \\* \\`success\\` - Payment successfully collected during dunning process.\n", "enum" : [ "in_progress", "exhausted", "stopped", "success" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`in_progress\\` - Dunning is still in progress. \\* \\`exhausted\\` - Maximum number of attempts have been made. \\* \\`stopped\\` - Dunning has stopped for this invoice. \\* \\`success\\` - Payment successfully collected during dunning process.\n", "enum" : [ "in_progress", "exhausted", "stopped", "success" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`in_progress\\` - Dunning is still in progress. \\* \\`exhausted\\` - Maximum number of attempts have been made. \\* \\`stopped\\` - Dunning has stopped for this invoice. \\* \\`success\\` - Payment successfully collected during dunning process.\n", "enum" : [ "in_progress", "exhausted", "stopped", "success" ], "pattern" : "^\\[(in_progress|exhausted|stopped|success)(,(in_progress|exhausted|stopped|success))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`in_progress\\` - Dunning is still in progress. \\* \\`exhausted\\` - Maximum number of attempts have been made. \\* \\`stopped\\` - Dunning has stopped for this invoice. \\* \\`success\\` - Payment successfully collected during dunning process.\n", "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
\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.\nSupported operators :\nafter, before, on, between
Example →\nupdated_at[on] = "1243545465"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "1243545465", "properties" : { "after" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "before" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "on" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[\\d{10},\\d{10}\\]$", "example" : null } } } }, { "name" : "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. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "pattern" : "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "pattern" : "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\]$", "example" : null } } } }, { "name" : "voided_at", "in" : "query", "description" : "optional, timestamp(UTC) in seconds filter\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.
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.",
"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.",
"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.",
"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.",
"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.
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.\ntaxes\nand\nline_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.
Set as true\nto remove the general note\nfrom this invoice.
The ISO 3166-2 state/province 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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The ISO 3166-2 state/province 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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if billing_state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_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.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's deviceThe billing address associated with the bank account. The value is a JSON object with the following keys and their values:- first_name:(string, max chars=150) The first name of the contact.
last_name:(string, max chars=150) The last name of the contact.company_name:(string, max chars=250) The company name for the address.line1:(string, max chars=180) The first line of the address.line2:(string, max chars=180) The second line of the address.country:(string) The name of the country for the address.country_code:(string, max chars=50) The two-letter, ISO 3166 alpha-2 country code for the address.state:(string, max chars=50) The name of the state or province for the address. When not provided, this is set automatically for US, Canada, India, and UAE.state_code:(string, max chars=50) The ISO 3166-2 state/province code without the country prefix. This is supported for USA, Canada, India, and UAE. For instance, for Arizona (USA), set state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC). For Dubai (UAE), set as DU (not AE-DU).city:(string, max chars=50) The city name for the address.postal_code:(string, max chars=20) The postal or ZIP code for the address.phone:(string, max chars=50) The contact phone number for the address.email:(string, max chars=70) The contact email address for the address.ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nIf you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, then XI\n(the code for United Kingdom - Northern Ireland\n) is available as an option.
checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_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.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's devicecheckout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_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.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's deviceQuantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
The price or per-unit-price of the addon. The value depends on the type of currency.
\nNote:
For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:
unit_price provided is $10Type of entity to which the note\nbelongs. To remove the general note, use the remove_general_note\nparameter.
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.
", "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
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/close" : { "post" : { "summary" : "Close a pending invoice", "description" : "Finalizes a pending invoice. Invoices are created with a pending status when Metered Billing 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.
Set as true\nto remove the general note\nfrom this invoice.
Type of entity to which the note\nbelongs. To remove the general note, use the remove_general_note\nparameter.
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.
", "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
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/apply_credits" : { "post" : { "summary" : "Apply credits for an invoice", "description" : "This API applies available credits to an invoice. After credits are applied, invoice.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.
Resource object representing invoice
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}" : { "get" : { "summary" : "Retrieve an invoice", "description" : "Important\nFor sites where both legacy and latest 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.
Override options:
chargebee-response-schema-type: items → Return response in latest product catalog format only.chargebee-response-schema-type: plans_addons → Return response in legacy product catalog format only.Retrieve the invoice for the specified invoice ID.
Specify the starting point for retrieving line items. Use the value from the line_items_next_offset attribute of the previous retrieve API response.
Note:
Resource object representing invoice
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/charge" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\\* retail -\n\nTransaction is a sale to an end user\n\\* vendor_use -\n\nTransaction is for an item that is subject to vendor use tax\n\\* wholesale -\n\nTransaction is a sale to another company that will resell your product or service to another consumer\n\\* consumed -\n\nTransaction 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.\ntaxes\nand\nline_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.
Resource object representing invoice
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/update_details" : { "post" : { "summary" : "Update invoice details", "description" : "This API allows you to update the invoice Billing/Shipping address, VAT, custom fields, and PO number. During this operation if Billing Info (Billing Address, vat_number), Shipping info and PO number are not already present in the system the data will be added. If data is already present, the existing values will be replaced. If info is present in the system, but not passed as part of the request, the info will not be removed from the system. \n**Note:**\nIncase, tax is already applied will now vary due to address change, you cannot update the address. You cannot update the VAT Number if the billing address is not present in the API request.This will update the invoice only, it won't change the corresponding customer/subscription details.\n", "operationId" : "update_invoice_details", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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.\nOnly applicable specifically for customers with billing_address
country\nas XI\n(which is United Kingdom - Northern Ireland\n).
When you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, you have the option of setting billing_address
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\nXI\nby default. However, if the VAT number was registered in UK, the value should be GB.\nSet\nvat_number_prefix\nto GB\nfor such cases.
The ISO 3166-2 state/province 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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The ISO 3166-2 state/province 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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
Resource object representing invoice
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/record_payment" : { "post" : { "summary" : "Record an invoice payment", "description" : "To record a [offline payment](https://www.chargebee.com/docs/offline_payments.html) 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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\\* cash -\n\nCash\n\\* other -\n\nPayment Methods other than the above types\n\\* custom -\n\nCustom\n\\* check -\n\nCheck\n\\* bank_transfer -\n\nBank Transfer\n", "enum" : [ "cash", "check", "bank_transfer", "other", "custom", "dana", "touch_n_go", "tamara", "qpay" ], "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\\* late_failure -\n\nIndicates 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 -\n\nTransaction failed. Refer the 'error_code' and 'error_text' fields to know the reason for failure\n\\* success -\n\nThe 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
" }, "transaction" : { "$ref" : "#/components/schemas/Transaction", "description" : "Resource object representing transaction
" } }, "required" : [ "invoice", "transaction" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/delete" : { "post" : { "summary" : "Delete an invoice", "description" : "Deletes the specified invoice. Any payments must be removed from the invoice before deleting it.
proration enabled, no prorated credits are issued.Resource object representing invoice
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/import_invoice" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\\* tax_inclusive -\n\nAll amounts in the document are inclusive of tax.\n\\* tax_exclusive -\n\nAll 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\\* zero_rated -\n\nIf the rate of tax is 0% and no Sales/ GST tax is collectable for that line item\n\\* export -\n\nThe customer is from a non-taxable region or the billing address and shipping address are unavailable.\n\\* customer_exempt -\n\nThe customer is [exempted](/docs/api/customers/customer-object#taxability)\nfrom tax.\n\\* tax_not_configured_external_provider -\n\nIf the tax is not configured for the country in 3rd party tax provider.\n\\* id_exempt -\n\nThe 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)\nor [UK VAT](https://www.chargebee.com/docs/uk-vat.html)\nis enabled.)\n\\* high_value_physical_goods -\n\nIf 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 -\n\nIf the Plan or Addon is marked as Tax exempt\n\\* region_non_taxable -\n\nIf 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 -\n\nIf 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.\nOnly applicable specifically for customers with billing_address
country\nas XI\n(which is United Kingdom - Northern Ireland\n).
When you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, you have the option of setting billing_address
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\nXI\nby default. However, if the VAT number was registered in UK, the value should be GB.\nSet\nvat_number_prefix\nto GB\nfor such cases.
Current status of this invoice.
\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 -The invoice 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_invoicesattribute is set to true.\nThe invoice is yet to be closed (sent for payment collection). All invoices are generated with this status when Metered Billing is enabled for the site.
Indicates the payment is not yet collected and is being retried as per retry settings.
", "enum" : [ "paid", "posted", "payment_due", "not_paid", "voided", "pending" ], "example" : null }, "voided_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Timestamp indicating the date \\& time this invoice got voided.\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.
The ISO 3166-2 state/province 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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The ISO 3166-2 state/province 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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
Quantity of the recurring item which is represented by this line item. For metered line items, this value is updated from usages once when the invoice is generated as pending and finally when the invoice is closed.\nQuantity of the recurring item which is represented by this line item.
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\nis enabled.
The decimal representation of the quantity of this line_item. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
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\nis enabled.
If id\nis not provided then our system will automatically generate a unique id.
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.
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.
", "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.
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.
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\nis enabled.
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\nis enabled.
The decimal representation of the quantity purchased from this tier. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
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\nis enabled.
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.
The type of deduction and the amount to which it is applied.
\n* item_level_coupon -The deduction is due to a coupon applied to line item. The coupon id\nis passed as entity_id\n.
The deduction is due to a coupon applied to the invoice sub_total.\nThe coupon id is passed as entity_id\n.
The deduction is due to a promotional credit\napplied to the invoice.
", "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.
The ISO 3166-2 state/province 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).
Resource object representing invoice
" }, "credit_note" : { "$ref" : "#/components/schemas/CreditNote", "description" : "Resource object representing credit_note
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/resume_dunning" : { "post" : { "summary" : "Resume dunning for invoice", "description" : "Immediately resumes dunning for the specified invoice.
This operation is only permitted for an invoice with a status of payment_due and for which dunning was previously paused.
Resource object representing invoice
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/record_tax_withheld" : { "post" : { "summary" : "Record tax withheld for an invoice", "description" : "Records tax_withheld by the customer against the invoice specified. This operation is allowed only when all of the following conditions are true:
invoice does not have a linked_taxes_withheld record associated with it already.invoice.amount_due is greater than zero.invoice.status is one of the following: payment_due, not_paid, or posted.The amount withheld by the customer as tax from the invoice. This must not exceed invoice.amount_due.\nThe unit depends on the type of currency.
Resource object representing invoice
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/resend_einvoice" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/remove_tax_withheld" : { "post" : { "summary" : "Remove tax withheld for an invoice", "description" : "Removes a linked_taxes_withheld record from the invoice specified. This operation is allowed only when all of the following conditions are true:
invoice.status is one of the following: payment_due, not_paid, or posted.adjustment_credit_notes associated with the invoice.issued_credit_notes associated with the invoice.An auto-generated unique identifier for the tax withheld. The value starts with the prefix tax_wh_.\nFor example, tax_wh_16BdDXSlbu4uV1Ee6\n.
Resource object representing invoice
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/payment_reference_numbers" : { "get" : { "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.
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.
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.
Important:
payment_due associated with the app_store and play_store channels.This 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.
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\n.
Resource object representing invoice
" }, "transaction" : { "$ref" : "#/components/schemas/Transaction", "description" : "Resource object representing transaction
" } }, "required" : [ "invoice", "transaction" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/sync_usages" : { "post" : { "summary" : "Sync usages", "description" : "Updates the quantity for metered line_items of an invoice to reflect the latest usage data.\nNote: This operation is done automatically while closing the invoice.
Resource object representing invoice
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/refund" : { "post" : { "summary" : "Refund an invoice", "description" : "Refunds the invoice. The refund 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:
If the refund transaction succeeds, a credit_note capturing this refund detail is created for the invoice.
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.
Note:\nAny linked_taxes_withheld\nassociated with the invoice cannot be refunded via this operation.
Resource object representing invoice
" }, "transaction" : { "$ref" : "#/components/schemas/Transaction", "description" : "Resource object representing transaction
" }, "credit_note" : { "$ref" : "#/components/schemas/CreditNote", "description" : "Resource object representing credit_note
" } }, "required" : [ "invoice", "transaction" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/record_refund" : { "post" : { "summary" : "Record refund for an invoice", "description" : "Refunds the invoice. The refund is provided against the following in order of precedence:
linked_paymentslinked_taxes_withheldlinked_paymentsExample
Consider an invoice with the following payments and tax withheld.
When recording a refund worth $40, the refund amount is split as follows:
For payments made via online transactions, the refund request is processed via the payment gateway originally used to charge the customer.
Tip
If 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.
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.
\nNote:\nAny linked_taxes_withheld\nassociated with the invoice can also be recorded as refunded via this operation.
The payment method of this transaction
\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 -Only applicable for a transaction of type\n= refund.\nThis value is set by Chargebee when an automated chargeback\noccurs. You can also set this explicitly when recording a refund\n.
The reference number for this transaction. For example, the check number when payment_method\n= check\n.
Resource object representing invoice
" }, "transaction" : { "$ref" : "#/components/schemas/Transaction", "description" : "Resource object representing transaction
" }, "credit_note" : { "$ref" : "#/components/schemas/CreditNote", "description" : "Resource object representing credit_note
" } }, "required" : [ "invoice" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/pdf" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\\* attachment -\n\nPDF is rendered as attachment in the browser\n\\* inline -\n\nPDF 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
" } }, "required" : [ "download" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/download_einvoice" : { "get" : { "summary" : "Download e-invoice", "description" : "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.
Note
status is success.cbc:EmbeddedDocumentBinaryObject, which is the Base64-encoded version of the PDF.Resource object representing download
", "items" : { "$ref" : "#/components/schemas/Download", "description" : "Resource object representing download" }, "example" : null } }, "required" : [ "downloads" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/credit_notes/{credit-note-id}/record_refund" : { "post" : { "summary" : "Record refund for a credit note", "description" : "Refunds a (refundable) credit note. The refund is provided against linked_payments first and then against any linked_taxes_withheld for the invoice associated with the credit_note. For payments made via online transactions, the refund request is processed via the payment source associated with the transaction.
The amount to be refunded (for online payments) or recorded as refunded (for offline payments). If not specified, the entire refundable amount\nfor this credit_note\nis refunded.
Note: Any linked_tax_withheld_refunds\nassociated with the credit_note\ncan also be recorded as refunded via this operation.
The payment method of this transaction
\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 -Only applicable for a transaction of type\n= refund.\nThis value is set by Chargebee when an automated chargeback\noccurs. You can also set this explicitly when recording a refund\n.
The reference number for this transaction. For example, the check number when payment_method\n= check\n.
Resource object representing credit_note
" }, "transaction" : { "$ref" : "#/components/schemas/Transaction", "description" : "Resource object representing transaction
" } }, "required" : [ "credit_note" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/credit_notes/import_credit_note" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\\* refundable -\n\nRefundable Credit Note\n\\* store -\n\nStore Credit Note\n\\* adjustment -\n\nAdjustment 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\\* refund_due -\n\nWhen the credits are yet to be used, or have been partially used.\n\\* refunded -\n\nWhen the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded).\n\\* voided -\n\nWhen the Credit Note has been cancelled.\n\\* adjusted -\n\nWhen 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.
An overridden value for the first two characters of the full VAT number.\nOnly applicable specifically for customers with billing_address
country\nas XI\n(which is United Kingdom - Northern Ireland\n).
When you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, you have the option of setting billing_address
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\nXI\nby default. However, if the VAT number was registered in UK, the value should be GB.\nSet\nvat_number_prefix\nto GB\nfor such cases.
Quantity of the recurring item which is represented by this line item. For metered line items, this value is updated from usages once when the invoice is generated as pending and finally when the invoice is closed.\nQuantity of the recurring item which is represented by this line item.
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\nis enabled.
The decimal representation of the quantity of this line_item. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
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\nis enabled.
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.
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\nis enabled.
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\nis enabled.
The decimal representation of the quantity purchased from this tier. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
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\nis enabled.
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.
The type of deduction and the amount to which it is applied.
\n* document_level_coupon -The deduction is due to a coupon applied to the invoice sub_total.\nThe coupon id is passed as entity_id\n.
The deduction is due to a coupon applied to line item. The coupon id\nis passed as entity_id\n.
The deduction is due to a promotional credit\napplied to the invoice.
", "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.
Resource object representing credit_note
" } }, "required" : [ "credit_note" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/credit_notes/{credit-note-id}/delete" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "credit_note" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/credit_notes/{credit-note-id}/pdf" : { "post" : { "summary" : "Retrieve credit note as PDF", "description" : "Gets the credit note as PDF. The returned URL is secure and allows download. The URL will expire in 60 minutes.\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\\* attachment -\n\nPDF is rendered as attachment in the browser\n\\* inline -\n\nPDF 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
" } }, "required" : [ "download" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/credit_notes/{credit-note-id}/send_einvoice" : { "post" : { "summary" : "Send an einvoice for credit notes", "description" : "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:
If e-invoicing is not enabled at the site and customer level.
\nIf there is an e-invoice generated already for the invoice.
\nIf the Use automatic e-invoicing option is selected.
\nIf there are no generated e-invoices with the failed or skipped status.
If the invoice status is voided or pending.
Resource object representing credit_note
" } }, "required" : [ "credit_note" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/credit_notes/{credit-note-id}/void" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "credit_note" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/credit_notes/{credit-note-id}/refund" : { "post" : { "summary" : "Refund a credit note", "description" : "Refunds a (refundable) credit note to the payment source associated with the transaction. Any linked_tax_withheld_refunds recorded against the credit note are not refunded.
The amount to be refunded. If not specified, the entire refundable amount\nfor this credit_note\nis refunded.
Note:\nAny linked_tax_withheld_refunds\nassociated with the credit_note\ncannot be refunded via this operation.
Resource object representing credit_note
" }, "transaction" : { "$ref" : "#/components/schemas/Transaction", "description" : "Resource object representing transaction
" } }, "required" : [ "credit_note", "transaction" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/credit_notes" : { "get" : { "summary" : "List credit notes", "description" : "Important\nFor sites where both legacy and latest 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.
Override options:
chargebee-response-schema-type: items → Return response in latest product catalog format only.chargebee-response-schema-type: plans_addons → Return response in legacy product catalog format only.Lists all the Credit Notes.
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.
The status of processing the e-invoice. To obtain detailed information about the current status\n, see message\n.
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.",
"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.",
"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.",
"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.",
"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.
Creates a credit_note for the specified invoice.
Note:
If the credit_note type is refundable, then linked_taxes_withheld.amount for the invoice specified can also be included in the total.
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\nis enabled.
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\nis enabled.
Resource object representing credit_note
" }, "invoice" : { "$ref" : "#/components/schemas/Invoice", "description" : "Resource object representing invoice
" } }, "required" : [ "credit_note" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/credit_notes/{credit-note-id}/download_einvoice" : { "get" : { "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.
Note
status is success or registered.cbc:EmbeddedDocumentBinaryObject, which is the Base64-encoded version of the PDF.Resource object representing download
", "items" : { "$ref" : "#/components/schemas/Download", "description" : "Resource object representing download" }, "example" : null } }, "required" : [ "downloads" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/credit_notes/{credit-note-id}/resend_einvoice" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "credit_note" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/credit_notes/{credit-note-id}/remove_tax_withheld_refund" : { "post" : { "summary" : "Remove tax withheld refunds from a credit note", "description" : "Removes a linked_tax_withheld_refunds\nrecord from the credit_note\n.
An auto-generated unique identifier for the tax withheld. The value starts with the prefix tax_wh_.\nFor example, tax_wh_16BdDXSlbu4uV1Ee6\n.
Resource object representing credit_note
" } }, "required" : [ "credit_note" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/credit_notes/{credit-note-id}" : { "get" : { "summary" : "Retrieve a credit note", "description" : "Important\nFor sites where both legacy and latest 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.
Override options:
chargebee-response-schema-type: items → Return response in latest product catalog format only.chargebee-response-schema-type: plans_addons → Return response in legacy product catalog format only.Retrieves the Credit Note identified by the specified Credit Note number.
Specify the starting point for retrieving line items. Use the value from the line_items_next_offset attribute of the previous retrieve API response.
Note:
Resource object representing credit_note
" } }, "required" : [ "credit_note" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/unbilled_charges/{unbilled-charge-id}/delete" : { "post" : { "summary" : "Delete an unbilled charge", "description" : "Use this API to delete an unbilled charge by specifying the id of the charge.\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "unbilled_charge" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/unbilled_charges/invoice_now_estimate" : { "post" : { "summary" : "Create an estimate for unbilled charges", "description" : "This is similar to the \"Create an invoice for unbilled charges\" API but no invoice will be created, only an estimate for this operation is created.\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "estimate" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/unbilled_charges/invoice_unbilled_charges" : { "post" : { "summary" : "Create an invoice for unbilled charges", "description" : "Use this API to bill the [unbilled charges](https://www.chargebee.com/docs/unbilled-charges.html). Available Credits and Excess Payments will automatically be applied while creating the invoice.\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
", "items" : { "$ref" : "#/components/schemas/Invoice", "description" : "Resource object representing invoice
" }, "example" : null } }, "required" : [ "invoices" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/unbilled_charges" : { "get" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "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.
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.
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
The price or per-unit-price of the addon. The value depends on the type of currency.
\nNote:
For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:
unit_price provided is $10Resource object representing unbilled_charge
", "items" : { "$ref" : "#/components/schemas/UnbilledCharge", "description" : "Resource object representing unbilled_charge" }, "example" : null } }, "required" : [ "unbilled_charges" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/orders" : { "get" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "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.
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.
Resource object representing order
" } }, "required" : [ "order" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/orders/import_order" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\\* shipped -\n\nThe order has moved from order management system to a shipping system.\n\\* queued -\n\nOrder is yet to be processed by any system, these are scheduled orders created by Chargebee\n\\* on_hold -\n\nThe order is paused from being processed.\n\\* returned -\n\nThe order has been returned after delivery.\n\\* delivered -\n\nThe order has been delivered to the customer.\n\\* awaiting_shipment -\n\nThe order has been picked up by an integration system, and synced to a shipping management platform\n\\* cancelled -\n\nOrder has been cancelled. Applicable only if you are using Chargebee's legacy order management system\n\\* partially_delivered -\n\nThe 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\\* shipping_cut_off_passed -\n\nThe invoice has been paid late and Chargebee cancel's the first order for the invoice.\n\\* invoice_voided -\n\nThe invoice for which the order was createed has been voided.\n\\* alternative_found -\n\nAlternative found.\n\\* others -\n\nOther reason\n\\* order_resent -\n\nOrder resent\n\\* product_unsatisfactory -\n\nProduct unsatisfactory.\n\\* delivery_date_missed -\n\nDelivery date missed.\n\\* subscription_cancelled -\n\nThe subsctiption for which the order was created has been cancelled.\n\\* fraudulent_transaction -\n\nFraudulent transaction.\n\\* invoice_written_off -\n\nThe invoice has been completely written off. Orders are generated by Chargebee in cancelled state.\n\\* product_not_required -\n\nProduct not required.\n\\* payment_declined -\n\nPayment declined.\n\\* product_not_available -\n\nProduct not available.\n\\* third_party_cancellation -\n\nThird 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\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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The ISO 3166-2 state/province 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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
Resource object representing order
" } }, "required" : [ "order" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/orders/{order-id}/assign_order_number" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "order" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/orders/{order-id}/resend" : { "post" : { "summary" : "Resend an order", "description" : "Resend an existing order. This will help in resending an existing order in full or partial. Upto 5 resend operations are allowed per . When resent fully, the original order is canceled.\n", "operationId" : "resend_an_order", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "order" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/orders/{order-id}/reopen" : { "post" : { "summary" : "Reopen a cancelled order", "description" : "This API is used to re-open a cancelled order\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "order" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/orders/{order-id}/cancel" : { "post" : { "summary" : "Cancel an order", "description" : "Cancel order and create a refundable credit note for the order\n", "operationId" : "cancel_an_order", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\\* shipping_cut_off_passed -\n\nThe invoice has been paid late and Chargebee cancel's the first order for the invoice.\n\\* alternative_found -\n\nAlternative found.\n\\* others -\n\nOther reason\n\\* product_unsatisfactory -\n\nProduct unsatisfactory.\n\\* product_not_required -\n\nProduct not required.\n\\* delivery_date_missed -\n\nDelivery date missed.\n\\* invoice_voided -\n\nThe invoice for which the order was createed has been voided.\n\\* payment_declined -\n\nPayment declined.\n\\* product_not_available -\n\nProduct not available.\n\\* subscription_cancelled -\n\nThe subsctiption for which the order was created has been cancelled.\n\\* third_party_cancellation -\n\nThird party cancellation.\n\\* fraudulent_transaction -\n\nFraudulent transaction.\n\\* order_resent -\n\nOrder resent\n\\* invoice_written_off -\n\nThe 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
" } }, "required" : [ "order" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/orders/{order-id}" : { "get" : { "summary" : "Retrieve an order", "description" : "Retrieves an order corresponding to the order id passed.\n", "operationId" : "retrieve_an_order", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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
" } }, "required" : [ "order" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] }, "post" : { "summary" : "Update an order", "description" : "Updates an order. If the status of an order is changed while updating the order, the status_update_at attribute is set with the current time.\n", "operationId" : "update_an_order", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\\* shipping_cut_off_passed -\n\nThe invoice has been paid late and Chargebee cancel's the first order for the invoice.\n\\* invoice_voided -\n\nThe invoice for which the order was createed has been voided.\n\\* alternative_found -\n\nAlternative found.\n\\* others -\n\nOther reason\n\\* order_resent -\n\nOrder resent\n\\* product_unsatisfactory -\n\nProduct unsatisfactory.\n\\* delivery_date_missed -\n\nDelivery date missed.\n\\* subscription_cancelled -\n\nThe subsctiption for which the order was created has been cancelled.\n\\* fraudulent_transaction -\n\nFraudulent transaction.\n\\* invoice_written_off -\n\nThe invoice has been completely written off. Orders are generated by Chargebee in cancelled state.\n\\* product_not_required -\n\nProduct not required.\n\\* payment_declined -\n\nPayment declined.\n\\* product_not_available -\n\nProduct not available.\n\\* third_party_cancellation -\n\nThird 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\\* voided -\n\nOrder has been voided. Applicable only if you are using Chargebee's legacy order management system\n\\* complete -\n\nOrder has been processed successfully. Applicable only if you are using Chargebee's legacy order management system\n\\* shipped -\n\nThe order has moved from order management system to a shipping system.\n\\* processing -\n\nOrder is being processed. Applicable only if you are using Chargebee's legacy order management system\n\\* queued -\n\nOrder is yet to be processed by any system, these are scheduled orders created by Chargebee\n\\* on_hold -\n\nThe order is paused from being processed.\n\\* new -\n\nOrder has been created. Applicable only if you are using Chargebee's legacy order management system.\n\\* returned -\n\nThe order has been returned after delivery.\n\\* delivered -\n\nThe order has been delivered to the customer.\n\\* awaiting_shipment -\n\nThe order has been picked up by an integration system, and synced to a shipping management platform\n\\* cancelled -\n\nOrder has been cancelled. Applicable only if you are using Chargebee's legacy order management system\n\\* partially_delivered -\n\nThe 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\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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
Resource object representing order
" } }, "required" : [ "order" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/orders/{order-id}/delete" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "order" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/orders/{order-id}/create_refundable_credit_note" : { "post" : { "summary" : "Create a refundable credit note", "description" : "This API is used to create a refundable credit note for the order\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\\* product_unsatisfactory -\n\nProduct Unsatisfactory\n\\* chargeback -\n\nCan be set when you are recording your customer Chargebacks\n\\* service_unsatisfactory -\n\nService Unsatisfactory\n\\* write_off -\n\nThis reason will be set automatically for the Credit Notes created during invoice [Write Off](https://www.chargebee.com/docs/invoice-operations.html#write-off)\noperation.\n\\* subscription_change -\n\nThis reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html)\nis enabled\n\\* fraudulent -\n\nFRAUDULENT\n\\* other -\n\nCan be set when none of the above reason codes are applicable\n\\* subscription_pause -\n\nThis reason will be automatically set to credit notes created during pause/resume subscription operation.\n\\* waiver -\n\nWaiver\n\\* order_cancellation -\n\nOrder Cancellation\n\\* order_change -\n\nOrder Change\n\\* subscription_cancellation -\n\nThis 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
" } }, "required" : [ "order" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/gifts/{gift-id}/cancel" : { "post" : { "summary" : "Cancel a gift", "description" : "This API allows to cancel gifts. Only gift in 'scheduled' and 'unclaimed' states can be cancelled.\n", "operationId" : "cancel_a_gift", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" }, "subscription" : { "$ref" : "#/components/schemas/Subscription", "description" : "Resource object representing subscription
" } }, "required" : [ "gift", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/gifts/{gift-id}/update_gift" : { "post" : { "summary" : "Update a gift", "description" : "Updates the attributes of a gift.
scheduled status.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 is false, the value must also be less than claim_expiry_date.
Resource object representing gift
" }, "subscription" : { "$ref" : "#/components/schemas/Subscription", "description" : "Resource object representing subscription
" } }, "required" : [ "gift", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/gifts" : { "get" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "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.
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.
When true\n, the claim happens automatically. When not passed, the default value in the site settings is used.
When true\n, indicates that the gift does not expire. Do not pass or pass as false\nwhen auto_claim\nis set.\n.
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.
checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_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.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's deviceThe ISO 3166-2 state/province 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).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
Resource object representing gift
" }, "subscription" : { "$ref" : "#/components/schemas/Subscription", "description" : "Resource object representing subscription
" }, "invoice" : { "$ref" : "#/components/schemas/Invoice", "description" : "Resource object representing invoice
" } }, "required" : [ "gift", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/gifts/{gift-id}" : { "get" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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
" }, "subscription" : { "$ref" : "#/components/schemas/Subscription", "description" : "Resource object representing subscription
" } }, "required" : [ "gift", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/gifts/{gift-id}/claim" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" }, "subscription" : { "$ref" : "#/components/schemas/Subscription", "description" : "Resource object representing subscription
" } }, "required" : [ "gift", "subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/transactions" : { "get" : { "summary" : "List transactions", "description" : "Lists all the transactions.
Note:
For 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.
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.
type = refund. This value is set by Chargebee when an automated chargeback occurs. You can also set this explicitly when recording a 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 ",
"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" ],
"example" : null
},
"is_not" : {
"type" : "string",
"description" : "* `card` - Card\n* `cash` - Cash\n* `check` - Check\n* `chargeback` - Only applicable for a transaction of type = refund. This value is set by Chargebee when an automated chargeback occurs. You can also set this explicitly when recording a 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 ",
"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" ],
"example" : null
},
"in" : {
"type" : "string",
"description" : "* `card` - Card\n* `cash` - Cash\n* `check` - Check\n* `chargeback` - Only applicable for a transaction of type = refund. This value is set by Chargebee when an automated chargeback occurs. You can also set this explicitly when recording a 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 ",
"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" ],
"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)(,(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))*\\]$",
"example" : null
},
"not_in" : {
"type" : "string",
"description" : "* `card` - Card\n* `cash` - Cash\n* `check` - Check\n* `chargeback` - Only applicable for a transaction of type = refund. This value is set by Chargebee when an automated chargeback occurs. You can also set this explicitly when recording a 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 ",
"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" ],
"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)(,(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))*\\]$",
"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, 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` - Ezidebit is a payment gateway integration based in Australia that supports automated direct debit, BPAY, and card payments for businesses.payment_source_type. \n* `deutsche_bank` - Deutsche Bank is the leading German bank with strong European roots and a global network. \n* `ezidebit` - Ezidebit is a payment gateway integration based in Australia that supports automated direct debit, BPAY, and card payments for businesses.payment_source_type. \n* `deutsche_bank` - Deutsche Bank is the leading German bank with strong European roots and a global network. \n* `ezidebit` - Ezidebit is a payment gateway integration based in Australia that supports automated direct debit, BPAY, and card payments for businesses.payment_source_type. \n* `deutsche_bank` - Deutsche Bank is the leading German bank with strong European roots and a global network. \n* `ezidebit` - Ezidebit is a payment gateway integration based in Australia that supports automated direct debit, BPAY, and card payments for businesses.optional, string filter
\nThe reference number for this transaction. For example, the check number when payment_method\n= check\n.\nSupported operators :\nis, is_not, starts_with, is_present
Example →\nreference_number[is] = "cus_u239732"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "cus_u239732", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "is_present" : { "type" : "string", "format" : "boolean", "enum" : [ "true", "false" ], "example" : null } } } }, { "name" : "type", "in" : "query", "description" : "optional, enumerated string filter\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 theamount from the customer’s payment_source.\n* `payment` - The transaction represents capture of amount from the customer’s payment_source.\n* `refund` - The transaction represents a refund of amount to the customer’s payment_source.\n* `payment_reversal` - Indicates a reversal transaction.",
"enum" : [ "authorization", "payment", "refund", "payment_reversal" ],
"example" : null
},
"is_not" : {
"type" : "string",
"description" : "* `authorization` - The transaction represents an authorization for capturing the amount from the customer’s payment_source.\n* `payment` - The transaction represents capture of amount from the customer’s payment_source.\n* `refund` - The transaction represents a refund of amount to the customer’s payment_source.\n* `payment_reversal` - Indicates a reversal transaction.",
"enum" : [ "authorization", "payment", "refund", "payment_reversal" ],
"example" : null
},
"in" : {
"type" : "string",
"description" : "* `authorization` - The transaction represents an authorization for capturing the amount from the customer’s payment_source.\n* `payment` - The transaction represents capture of amount from the customer’s payment_source.\n* `refund` - The transaction represents a refund of amount to the customer’s payment_source.\n* `payment_reversal` - Indicates a reversal transaction.",
"enum" : [ "authorization", "payment", "refund", "payment_reversal" ],
"pattern" : "^\\[(authorization|payment|refund|payment_reversal)(,(authorization|payment|refund|payment_reversal))*\\]$",
"example" : null
},
"not_in" : {
"type" : "string",
"description" : "* `authorization` - The transaction represents an authorization for capturing the amount from the customer’s payment_source.\n* `payment` - The transaction represents capture of amount from the customer’s payment_source.\n* `refund` - The transaction represents a refund of amount to the customer’s payment_source.\n* `payment_reversal` - Indicates a reversal transaction.",
"enum" : [ "authorization", "payment", "refund", "payment_reversal" ],
"pattern" : "^\\[(authorization|payment|refund|payment_reversal)(,(authorization|payment|refund|payment_reversal))*\\]$",
"example" : null
}
}
}
}, {
"name" : "date",
"in" : "query",
"description" : "optional, timestamp(UTC) in seconds filter
\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.\nSupported operators :\nafter, before, on, between
Example →\ndate[before] = "1435054328"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "1435054328", "properties" : { "after" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "before" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "on" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[\\d{10},\\d{10}\\]$", "example" : null } } } }, { "name" : "amount", "in" : "query", "description" : "optional, in cents filter\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. \\* \\`success\\` - The transaction is successful. \\* \\`voided\\` - The transaction got voided or authorization expired at gateway. \\* \\`failure\\` - Transaction failed. Refer the 'error_code' and 'error_text' fields to know the reason for failure \\* \\`timeout\\` - Transaction failed because of Gateway not accepting the connection. \\* \\`needs_attention\\` - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually \\* \\`late_failure\\` - This status indicates that late failure has been recorded for the transaction that has encountered success state in the previous stage.\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. \\* \\`success\\` - The transaction is successful. \\* \\`voided\\` - The transaction got voided or authorization expired at gateway. \\* \\`failure\\` - Transaction failed. Refer the 'error_code' and 'error_text' fields to know the reason for failure \\* \\`timeout\\` - Transaction failed because of Gateway not accepting the connection. \\* \\`needs_attention\\` - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually \\* \\`late_failure\\` - This status indicates that late failure has been recorded for the transaction that has encountered success state in the previous stage.\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. \\* \\`success\\` - The transaction is successful. \\* \\`voided\\` - The transaction got voided or authorization expired at gateway. \\* \\`failure\\` - Transaction failed. Refer the 'error_code' and 'error_text' fields to know the reason for failure \\* \\`timeout\\` - Transaction failed because of Gateway not accepting the connection. \\* \\`needs_attention\\` - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually \\* \\`late_failure\\` - This status indicates that late failure has been recorded for the transaction that has encountered success state in the previous stage.\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. \\* \\`success\\` - The transaction is successful. \\* \\`voided\\` - The transaction got voided or authorization expired at gateway. \\* \\`failure\\` - Transaction failed. Refer the 'error_code' and 'error_text' fields to know the reason for failure \\* \\`timeout\\` - Transaction failed because of Gateway not accepting the connection. \\* \\`needs_attention\\` - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually \\* \\`late_failure\\` - This status indicates that late failure has been recorded for the transaction that has encountered success state in the previous stage.\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
\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.\nSupported operators :\nafter, before, on, between
Example →\nupdated_at[before] = "1243545465"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "1243545465", "properties" : { "after" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "before" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "on" : { "type" : "string", "format" : "unix-time", "pattern" : "^\\d{10}$", "example" : null }, "between" : { "type" : "string", "pattern" : "^\\[\\d{10},\\d{10}\\]$", "example" : null } } } }, { "name" : "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
" } }, "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.
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 that can be updated to either success or failure status.
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.
Note:
needs_attention to success. It is recommended to pass this value if available in the gateway.id_at_gateway value does not match the id_at_gateway value stored against the transaction in Chargebee.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.
\nNote:
An error occurs when the provided customer_id\nvalue does not match the customer_id\nvalue stored against the transaction in Chargebee.
The status of this transaction. The status can only be updated when the transaction status is in needs_attention\n.
When the transaction is in failure status.
\nNote:
When the transaction is updated to failure status and the invoice is associated with the transaction,
payment_due status if the dunning is configured.not_paid status if the dunning is not configured.When the transaction is successful.
\nNote:
When the transaction is updated to success\nstatus, - and the invoice is associated with the transaction, the transaction amount will be applied to the invoice.
customer_excess_payments will be updated.Resource object representing transaction
" } }, "required" : [ "transaction" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/transactions/{transaction-id}" : { "get" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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
" } }, "required" : [ "transaction" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/transactions/{transaction-id}/refund" : { "post" : { "summary" : "Refund a payment", "description" : "Refunds an online payment. Applicable only for transactions of type = payment. You can only refund a transaction whose status is success.
The amount to be refunded. Must not exceed amount_unused.\nIf not passed then all of amount_unused\nis refunded.
Resource object representing transaction
" } }, "required" : [ "transaction" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/transactions/{transaction-id}/record_refund" : { "post" : { "summary" : "Record an offline refund", "description" : "Records a refund made offline. Applicable only for transactions of type = payment.
The amount to be recorded as refunded. Must not exceed amount_unused.\nIf not passed then all of amount_unused\nis recorded as refunded.
The payment method used to make the refund.
\n* check -Check
\n* cash -Cash
\n* custom -Custom
\n* chargeback -Only applicable for a transaction of type\n= refund.\nThis value is set by Chargebee when an automated chargeback\noccurs. You can also set this explicitly when recording a refund\n.
Payment Methods other than the above types
\n* bank_transfer -Bank Transfer
", "enum" : [ "cash", "check", "chargeback", "bank_transfer", "other", "custom", "dana", "touch_n_go", "tamara", "qpay" ], "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.
Resource object representing transaction
" } }, "required" : [ "transaction" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/transactions/{transaction-id}/void" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "transaction" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/transactions/create_authorization" : { "post" : { "summary" : "Create an authorization payment", "description" : "Authorizes a specific amount in customer's Credit card, which can be collected within a span of time. Read more on authorization and capture [here](https://www.chargebee.com/docs/payments/1.0/payment-gateways-and-configuration/stripe#auth-and-capture). \n* Supported only for Card payments.\n* Currently supported only for **Stripe**.\n", "operationId" : "create_an_authorization_payment", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "transaction" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/invoices/{invoice-id}/payments" : { "get" : { "summary" : "List payments for an invoice", "description" : "Retrieves the payments for an invoice with the recent ones on top. This returns all the payment attempts(manual \\& automatic) made for this invoice.\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "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.
Resource object representing transaction
" } }, "required" : [ "transaction" ], "example" : null }, "example" : null }, "next_offset" : { "type" : "string", "description" : "This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter offset.
Resource object representing transaction
" } }, "required" : [ "transaction" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/hosted_pages/extend_subscription" : { "post" : { "summary" : "Extend subscription", "description" : "This API generates a hosted page URL to extend the billing cycle of a subscription.
Use one of the following methods to open the hosted page:
openCheckout() to open the hosted page in a modal popup in your website or application.url.Do not embed the hosted page in your own iframe.
Resource object representing hosted_page
" } }, "required" : [ "hosted_page" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/hosted_pages/events" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\\* cancellation_page_loaded -\n\nIndicates 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.
\nsubscription_id: A unique and immutable identifier for the subscription.\n.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.
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.
Create a Chargebee hosted page to accept payment from a customer and checkout non-recurring addons and one-time charges.
The following steps describe how best to use this API:
url received in the response.customer record in Chargebee, and they are redirected to the redirect_url with the id and state attributes passed as query string parameters.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.
\nNote :
\nredirect_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 or invoice_generated to verify a successful checkout.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's query parameters. Using this ID, you can fetch the hosted page and perform actions related to the success of the marketing campaign.
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.
Specifies if the customer is liable for tax
\n* exempt -entity_code or exempt_number attributes if you use Chargebee's AvaTax for Sales or specify exemption_details attribute if you use Chargebee's AvaTax for Communications 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.Computes tax for the customer based on the site configuration.\nIn some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that's not available either, the tax is taken as zero.
", "enum" : [ "taxable", "exempt" ], "example" : null }, "vat_number" : { "type" : "string", "deprecated" : false, "description" : "The VAT/tax registration number for the customer. For customers with billing_address
country\nas\nXI\n(which is United Kingdom - Northern Ireland\n), the first two characters of the full VAT number\ncan be overridden by setting\nvat_number_prefix\n.
An overridden value for the first two characters of the full VAT number.\nOnly applicable specifically for customers with billing_address
country\nas XI\n(which is United Kingdom - Northern Ireland\n).
When you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, you have the option of setting billing_address
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\nXI\nby default. However, if the VAT number was registered in UK, the value should be GB.\nSet\nvat_number_prefix\nto GB\nfor such cases.
Indicates whether invoices raised on the same day for the customer are consolidated. When provided, this overrides the default configuration at the site-level. This parameter can be provided only when Consolidated Invoicing is enabled.
Note:
Any invoices raised when a subscription activates from in_trial or future status, are not consolidated by default. Contact Support to enable consolidation for such invoices.
The ISO 3166-2 state/province 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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The ISO 3166-2 state/province 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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
Unique ID of the addon to be added to the invoice.
\nConstraints\nThe addon must have charge_type set to charge.
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
Resource object representing hosted_page
" } }, "required" : [ "hosted_page" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/hosted_pages/view_voucher" : { "post" : { "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.
Resource object representing hosted_page
" } }, "required" : [ "hosted_page" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/hosted_pages/checkout_new" : { "post" : { "summary" : "Checkout new subscription", "description" : "Hosted page to accept card details from the subscriber and create a new subscription. This is similar to our server to server API [Create a Subscription](/docs/api/v2/pcv-1/subscriptions/create-a-subscription).\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/checkout-portal-docs/checkout-new-tutorial.html)\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\\* immediate -\n\nSubscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..\n\\* delayed -\n\nSubscription 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.
\nNote :
\nredirect_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 or invoice_generated to verify a successful checkout.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's query parameters. Using this ID, you can fetch the hosted page and perform actions related to the success of the marketing campaign.
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\ndirectly.
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:
\nstart_date cannot be earlier than 14th February.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\n.
The unique ID of the customer for which this hosted_page should be created.
subscription[id]. If subscription[id] is unavailable, then the customer ID is autogenerated.customer[id] while generating the checkout URL. This enables Chargebee to validate against existing subscriptions for the customer. Without it, the validation is skipped.Specifies if the customer is liable for tax
\n* exempt -entity_code or exempt_number attributes if you use Chargebee's AvaTax for Sales or specify exemption_details attribute if you use Chargebee's AvaTax for Communications 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.Computes tax for the customer based on the site configuration.\nIn some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that's not available either, the tax is taken as zero.
", "enum" : [ "taxable", "exempt" ], "example" : null }, "vat_number" : { "type" : "string", "deprecated" : false, "description" : "The VAT/tax registration number for the customer. For customers with billing_address
country\nas\nXI\n(which is United Kingdom - Northern Ireland\n), the first two characters of the full VAT number\ncan be overridden by setting\nvat_number_prefix\n.
An overridden value for the first two characters of the full VAT number.\nOnly applicable specifically for customers with billing_address
country\nas XI\n(which is United Kingdom - Northern Ireland\n).
When you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, you have the option of setting billing_address
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\nXI\nby default. However, if the VAT number was registered in UK, the value should be GB.\nSet\nvat_number_prefix\nto GB\nfor such cases.
Indicates whether invoices raised on the same day for the customer are consolidated. When provided, this overrides the default configuration at the site-level. This parameter can be provided only when Consolidated Invoicing is enabled.
Note:
Any invoices raised when a subscription activates from in_trial or future status, are not consolidated by default. Contact Support to enable consolidation for such invoices.
The ISO 3166-2 state/province 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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The ISO 3166-2 state/province 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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
Action to be taken when the contract term completes.
\n* evergreen -Contract term completes and the subscription renews.
\n* renew -contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.Contract term completes and subscription is canceled.
", "enum" : [ "renew", "evergreen", "cancel" ], "example" : null }, "cancellation_cutoff_period" : { "type" : "integer", "format" : "int32", "default" : 0, "deprecated" : false, "description" : "The number of days before contract_end\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.
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
The price or per-unit-price of the addon. The value depends on the type of currency.
\nNote:
For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:
unit_price provided is $10When price overriding\nis enabled for the site, the price or per-unit price of the addon can be set here. The value set for the addon\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\nis enabled.
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
Resource object representing hosted_page
" } }, "required" : [ "hosted_page" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/hosted_pages/collect_now" : { "post" : { "summary" : "Collect now", "description" : "This API generates a hosted page URL to collect due payments for the customer.
Open 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.
openCheckout() not supported
The Chargebee.js openCheckout() 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')).
Resource object representing hosted_page
" } }, "required" : [ "hosted_page" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/hosted_pages/checkout_gift" : { "post" : { "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).
When 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.
Once the gifter checks out using the hosted page returned by this endpoint, Chargebee checks if a customer resource with the receiver's email address exists. The first such customer record is considered the receiver's customer resource. A new customer resource is created for the receiver if none are found.
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.
\nNote :
\nredirect_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 or invoice_generated to verify a successful checkout.Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
Resource object representing hosted_page
" } }, "required" : [ "hosted_page" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/hosted_pages/accept_quote" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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.
\nNote :
\nredirect_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 or invoice_generated to verify a successful checkout.Resource object representing hosted_page
" } }, "required" : [ "hosted_page" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/hosted_pages/claim_gift" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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.
\nNote :
\nredirect_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 or invoice_generated to verify a successful checkout.Resource object representing hosted_page
" } }, "required" : [ "hosted_page" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/hosted_pages/pre_cancel" : { "post" : { "summary" : "Create a pre-cancel hosted page", "description" : "Creates a hosted_page\nresource of type\npre_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\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\nin the endpoint response.
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 property. The fields provided in pass_thru_content.custom must be preconfigured in Chargebee Growth.
Although only pass_thru_content.custom is sent to Chargebee Growth, all of pass_thru_content is stored by Chargebee Billing and is retrievable as an attribute of the hosted_page.\n.
Resource object representing hosted_page
" } }, "required" : [ "hosted_page" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/hosted_pages/{hosted-page-id}/acknowledge" : { "post" : { "summary" : "Acknowledge a hosted page", "description" : "When a hosted page is successfully completed by the user and processed by Chargebee, its 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.
Note:\nThe hosted page status must be succeeded for this API call to be allowed.
Resource object representing hosted_page
" } }, "required" : [ "hosted_page" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/hosted_pages/retrieve_agreement_pdf" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "hosted_page" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/hosted_pages/{hosted-page-id}" : { "get" : { "summary" : "Retrieve a hosted page", "description" : "Retrieves a hosted page resource.\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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
" } }, "required" : [ "hosted_page" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/hosted_pages/manage_payment_sources" : { "post" : { "summary" : "Manage payment sources", "description" : "This API generates a hosted page URL to add new or update existing payment sources for the customer.
Use one of the following methods to open the hosted page:
openCheckout() to open the hosted page in a modal popup in your website or application.url.Do not embed the hosted page in your own iframe.
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.
\nNote :
\nredirect_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 or invoice_generated to verify a successful checkout.Resource object representing hosted_page
" } }, "required" : [ "hosted_page" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/hosted_pages/checkout_existing" : { "post" : { "summary" : "Checkout existing subscription", "description" : "You can checkout an existing subscription(typically in the trial state) by passing in the plan, quantity and addon details(like [Update a Subscription](/docs/api/v2/pcv-1/subscriptions/update-a-subscription))\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/checkout-portal-docs/checkout-existing-tutorial.html)\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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:
invoice_date must be in the past.invoice_date is not more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.changes_scheduled_at, reactivate_from, or trial_end.invoice_immediately is true.\n.The number of subscription billing cycles to invoice in advance.\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.
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.\nNote:\nIt is recommended not to pass this parameter along with changed_scheduled_at.\nreactivate_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:
changes_scheduled_at cannot be earlier than 14th February.\n.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.
Note: This parameter is relevant only for subscriptions with status of active, non_renewing, or cancelled.
When 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.
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.
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.
\nNote :
\nredirect_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 or invoice_generated to verify a successful checkout.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's query parameters. Using this ID, you can fetch the hosted page and perform actions related to the success of the marketing campaign.
The new start date of a future\nsubscription. Applicable only for future\nsubscriptions.
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.\nNote:\nThis parameter can be backdated (set to a value in the past) only when the subscription is in cancelled\nor in_trial\nstatus.\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\ndirectly.
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\n.
The VAT/tax registration number for the customer. For customers with billing_address
country\nas\nXI\n(which is United Kingdom - Northern Ireland\n), the first two characters of the full VAT number\ncan be overridden by setting\nvat_number_prefix\n.
An overridden value for the first two characters of the full VAT number.\nOnly applicable specifically for customers with billing_address
country\nas XI\n(which is United Kingdom - Northern Ireland\n).
When you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, you have the option of setting billing_address
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\nXI\nby default. However, if the VAT number was registered in UK, the value should be GB.\nSet\nvat_number_prefix\nto GB\nfor such cases.
Action to be taken when the contract term completes.
\n* evergreen -Contract term completes and the subscription renews.
\n* renew -contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.Contract term completes and subscription is canceled.
", "enum" : [ "renew", "evergreen", "cancel" ], "example" : null }, "cancellation_cutoff_period" : { "type" : "integer", "format" : "int32", "default" : 0, "deprecated" : false, "description" : "The number of days before contract_end\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.
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
The price or per-unit-price of the addon. The value depends on the type of currency.
\nNote:
For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:
unit_price provided is $10When price overriding\nis enabled for the site, the price or per-unit price of the addon can be set here. The value set for the addon\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\nis enabled.
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
Resource object representing hosted_page
" } }, "required" : [ "hosted_page" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/renewal_estimate" : { "get" : { "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.
Resource object representing estimate
" } }, "required" : [ "estimate" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/estimates/update_subscription" : { "post" : { "summary" : "Update subscription estimate", "description" : "Generates an estimate for the 'update subscription' operation. The input will be similar to the Update Subscription API but subscription will not be updated, only an estimate will be created.
In the response,
subscription_estimate: The details of the changed subscription such as status, next billing date, and so on.invoice_estimate:The details of the immediate invoice, if it is generated. An immediate invoice is not generated when:\nend_of_term parameter is trueprorate parameter is falsesubscription or addons.next_invoice_estimate:The details of the invoice to be generated later (if any) on the occasion that no immediate invoice has been generated.credit_note_estimates:The list of credit notes (if any) generated during this operation.unbilled_charge_estimates: The details of charges that have not been invoiced. This is returned only if the invoice_immediately parameter is set to false.Note: If you have configured EU VAT or Customized taxes, 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.
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.\nchanges_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:
Backdating must be enabled for subscription change operations.
\nOnly the following changes can be backdated:
\nChanges in the recurring items or their prices.
\nAddition of non-recurring items.
\nSubscription status is active, cancelled, or non_renewing.
The current day of the month does not exceed the limit set in Chargebee for backdating subscription change. This limit is typically the day of the month by which the accounting for the previous month must be closed.
\nThe date is on or after current_term_start.
The date is on or after the last date/time any of the following changes were made:
\nChanges in the recurring items or their prices.
\nAddition of non-recurring items.
\nThe 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.
When the quote is converted, this attribute determines the date/time as of when the subscription change is to be carried out.
\n* end_of_term -The change is carried out at the end of the current billing cycle of the subscription.
\n* specific_date -The change is carried out as of the date specified under changes_scheduled_at\n.
The change is carried out immediately.
", "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:
invoice_date must be in the past.invoice_date is not more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.changes_scheduled_at, reactivate_from, or trial_end.invoice_immediately is true.\n.The number of subscription billing cycles to invoice in advance.\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.
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.\nNote:\nIt is recommended not to pass this parameter along with changed_scheduled_at.\nreactivate_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:
changes_scheduled_at cannot be earlier than 14th February.\n.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.
true: Prorated credits or charges are created as applicable for this change.false: The subscription is changed without creating any credits or charges.Caveat
For further changes within the same billing term, when prorate is set to true, credits are not created when all the conditions below hold true:
An immediate previous change was made
prorate set to false andSay 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).\nNote:\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.
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.
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.\nThe default value is as per the site settings\n.
\nNote:\ninvoice_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.
.
", "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.
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.\nNote:\nThis parameter can be backdated (set to a value in the past) only when the subscription is in cancelled\nor in_trial\nstatus.\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.
Applicable only when End-of-trial Action\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* activate_subscription -The subscription activates and charges are raised for non-metered items.
\n* cancel_subscription -The subscription cancels.
\n* plan_default -The action configured for the site\nat the time when the trial ends, takes effect. This is the default value when trial_end_action\nis defined for the plan.
The action configured for the site\nat the time when the trial ends, takes effect. This is the default value when trial_end_action\nis not\ndefined for the plan.
The ISO 3166-2 state/province 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).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The ISO 3166-2 state/province 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).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
An overridden value for the first two characters of the full VAT number.\nOnly applicable specifically for customers with billing_address
country\nas XI\n(which is United Kingdom - Northern Ireland\n).
When you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, you have the option of setting billing_address
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\nXI\nby default. However, if the VAT number was registered in UK, the value should be GB.\nSet\nvat_number_prefix\nto GB\nfor such cases.
Confirms that a customer is registered under GST. If set to true\nthen the Reverse Charge Mechanism\nis applicable. This field is applicable only when Australian GST is configured for your site.
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
The price or per-unit-price of the addon. The value depends on the type of currency.
\nNote:
For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:
unit_price provided is $10When price overriding\nis enabled for the site, the price or per-unit price of the addon can be set here. The value set for the addon\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\nis enabled.
The time at which the trial ends for the addon. To update this value, redo the complete addon set using replace_addon_list.\n(Addon trial periods must be enabled by Chargebee Support\n.)
Specifies how to manage charges or credits for the addon for this estimate. It's relevant only for addons that have their pricing_model\nset to per_unit.\nYou may use this parameter only if the change to the subscription takes effect immediately.
Note\nIf you don't provide a value, Chargebee determines the proration logic based on the following precedence: this parameter > prorate parameter > addon.proration_type > site-wide proration setting.
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.
", "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.
Resource object representing estimate
" } }, "required" : [ "estimate" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/resume_subscription_estimate" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\\* immediately -\n\nResume immediately\n\\* specific_date -\n\nResume 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\\* add_to_unbilled_charges -\n\nAdd to unbilled charges\n\\* invoice_immediately -\n\nInvoice 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
" } }, "required" : [ "estimate" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/estimates/gift_subscription" : { "post" : { "summary" : "Gift subscription estimate", "description" : "Generates an estimate for the 'create a gift' operation. This is similar to the [Create a gift](/docs/api/v2/pcv-1/gifts/create-a-gift) API, but the gift subscription will not be created. Only an estimate for this operation is created.\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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.
When true\n, indicates that the gift does not expire. Do not pass or pass as false\nwhen auto_claim\nis set.
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.
checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
payer: User related information.\ncountry_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.document: Document ID is the user's identification number based on their country.bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.fraud_merchant_id: Your merchant ID for fraud detection.chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
fraud: Fraud identification related information.\nfraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.bank_of_america: While passing raw card details to Bank of America, your user's device_session_id can be added to perform additional validation and avoid fraudulent transactions.
fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's device.ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
payer: User related information.\ndocument: Document is the user's identification number based on their country.fraud: Fraud identification related information.\ndevice_session_id: Session ID associated with the user's deviceThe ISO 3166-2 state/province 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).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
Resource object representing estimate
" } }, "required" : [ "estimate" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/upcoming_invoices_estimate" : { "get" : { "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" : "", "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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
" } }, "required" : [ "estimate" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/regenerate_invoice_estimate" : { "post" : { "summary" : "Regenerate invoice estimate", "description" : "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:
status is not voided.Returns an estimate object with one of the following components depending on the value of invoice_immediately.
true: an invoice_estimate object that corresponds to the regenerated invoice.false: a list of unbilled_charge_estimate objects corresponding to all the unbilled charges created for the current term of the subscription.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.
Only applicable when Consolidated Invoicing\nis enabled for the customer. Set to false\nto leave the current term charge for the subscription as unbilled.\nOnce you have done this for all suitable subscriptions of the customer, call Create an invoice for unbilled charges\nto invoice them.
Resource object representing estimate
" } }, "required" : [ "estimate" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/create_subscription_estimate" : { "get" : { "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.\nThe default value is as per the site settings\n.
\nNote:\ninvoice_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.
.
", "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\\* delayed -\n\nSubscription period will be aligned with the configured billing date at the next renewal.\n\\* immediate -\n\nSubscription 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.\ntaxes\nand\nline_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.
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:
\nstart_date cannot be earlier than 14th February.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\n.
The ISO 3166-2 state/province 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).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The number of days before 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.
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
The price or per-unit-price of the addon. The value depends on the type of currency.
\nNote:
For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:
unit_price provided is $10When price overriding\nis enabled for the site, the price or per-unit price of the addon can be set here. The value set for the addon\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\nis enabled.
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\n)
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
Resource object representing estimate
" } }, "required" : [ "estimate" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/change_term_end_estimate" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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.\nThe default value is as per the site settings\n.
\nNote:\ninvoice_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.
.
", "example" : null } }, "required" : [ "term_ends_at" ], "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "estimate" : { "$ref" : "#/components/schemas/Estimate", "description" : "Resource object representing estimate
" } }, "required" : [ "estimate" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/pause_subscription_estimate" : { "post" : { "summary" : "Pause subscription estimate", "description" : "This API provides an estimate of the details pertaining to the pause_subscription operation. It returns attributes such as pause_date and resume_date. This is similar to the Pause a subscription API with the exception that the subscription is not paused. Only an estimate for this operation is created.
In the response,
List of options to pause the subscription.
\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
Pause immediately
\n* end_of_term -Pause at the end of current term
\n* specific_date -Pause on a specific date
", "enum" : [ "immediately", "end_of_term", "specific_date", "billing_cycles" ], "example" : null }, "unbilled_charges_handling" : { "type" : "string", "deprecated" : false, "description" : "Applicable when unbilled charges are present for the subscription and pause_option is set as immediately. Note: On the invoice raised, an automatic charge is attempted on the payment method available, if customer's auto-collection property is set to on.
Invoice charges\nIf 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.
Retain as unbilled\nIf no_action is chosen, charges are added to the resumption invoice.
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.
Resource object representing estimate
" } }, "required" : [ "estimate" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/advance_invoice_estimate" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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" : "schedule_type = immediate: the number of future billing cycles to be invoiced in advance. The invoicing is done for the remaining_billing_cycles of the subscription if that is less than terms_to_charge.schedule_type = fixed_intervals: The number of future billing cycles in one interval. The schedule is created such that the total number of billing cycles in the schedule does not exceed the remaining_billing_cycles of the subscription.\n.Whether the charge should be invoiced immediately or added to unbilled_charges.\nApplicable only when schedule_type\nis immediate\n.
The type of advance invoice or advance invoicing schedule.
\n* immediate -Charge immediately for the number of billing cycles specified by terms_to_charge\n.
Charge on specific dates.\nFor each date, specify the number of billing cycles\nto charge for. Up to 5 dates can be configured.
\n* fixed_intervals -Charge at fixed intervals of time. Specify the number of billing cycles\nthat constitute an interval and the number of days before each interval\nthat the invoice should be generated. Also specify when the schedule should end\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\nof the subscription. This parameter is applicable only when fixed_interval_schedule[end_schedule_on]\n= after_number_of_intervals
Specifies when the schedule should end.
\n* after_number_of_intervals -Advance invoices are generated a specified number of times
Advance invoices are generated for as long as the subscription is active.
\n* specific_date -End the advance invoicing schedule on a specific date\n.
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]\n= specific_date\n.
The number of billing cycles to charge for, on the date specified. Applicable only when schedule_type\nis specific_dates.
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\nis specific_dates\n.
Resource object representing estimate
" } }, "required" : [ "estimate" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/estimates/create_subscription" : { "post" : { "summary" : "Create subscription estimate", "description" : "Generates an estimate for the 'create subscription' operation. This is similar to the Create Subscription API but no subscription will be created, only an estimate for this operation is created.
In the response,
estimate.subscription_estimate has the subscription details like the status of the subscription (in_trial, active, etc.), next billing date, and so on.
\nestimate.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.
\nestimate.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.
If 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'.
Tip
Set the customer[taxability]\nattribute as true\nand provide any other necessary parameters to compute taxes. Otherwise tax is exempted for the estimate.
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.\nThe default value is as per the site settings\n.
\nNote:\ninvoice_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.
.
", "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.\ntaxes\nand\nline_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.
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:
\nstart_date cannot be earlier than 14th February.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\n.
The ISO 3166-2 state/province 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).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The ISO 3166-2 state/province 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).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
An overridden value for the first two characters of the full VAT number.\nOnly applicable specifically for customers with billing_address
country\nas XI\n(which is United Kingdom - Northern Ireland\n).
When you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, you have the option of setting billing_address
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\nXI\nby default. However, if the VAT number was registered in UK, the value should be GB.\nSet\nvat_number_prefix\nto GB\nfor such cases.
Confirms that a customer is registered under GST. If set to true\nthen the Reverse Charge Mechanism\nis applicable. This field is applicable only when Australian GST is configured for your site.
Specifies if the customer is liable for tax
\n* exempt -entity_code or exempt_number attributes if you use Chargebee's AvaTax for Sales or specify exemption_details attribute if you use Chargebee's AvaTax for Communications 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.Computes tax for the customer based on the site configuration.\nIn some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that's not available either, the tax is taken as zero.
", "enum" : [ "taxable", "exempt" ], "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\\* med2 -\n\nUS Medical Device Excise Tax with taxable sales tax\n\\* med1 -\n\nUS Medical Device Excise Tax with exempt sales tax\n\\* b -\n\nState government\n\\* c -\n\nTribe/Status Indian/Indian Band\n\\* a -\n\nFederal government\n\\* f -\n\nReligious organization\n\\* g -\n\nResale\n\\* d -\n\nForeign diplomat\n\\* e -\n\nCharitable or benevolent organization\n\\* j -\n\nDirect pay permit\n\\* k -\n\nDirect mail\n\\* h -\n\nCommercial agricultural production\n\\* i -\n\nIndustrial production/manufacturer\n\\* n -\n\nLocal government\n\\* l -\n\nOther or custom\n\\* m -\n\nEducational organization\n\\* r -\n\nNon-resident\n\\* p -\n\nCommercial aquaculture\n\\* q -\n\nCommercial 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\\* business -\n\nWhen the purchase is made at a place of business\n\\* residential -\n\nWhen the purchase is made by a customer for home use\n\\* industrial -\n\nWhen the purchase is made by an industrial business\n\\* senior_citizen -\n\nWhen 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* evergreen -Contract term completes and the subscription renews.
\n* renew -contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.Contract term completes and subscription is canceled.
", "enum" : [ "renew", "evergreen", "cancel" ], "example" : null }, "cancellation_cutoff_period" : { "type" : "integer", "format" : "int32", "default" : 0, "deprecated" : false, "description" : "The number of days before contract_end\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.
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
The price or per-unit-price of the addon. The value depends on the type of currency.
\nNote:
For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:
unit_price provided is $10When price overriding\nis enabled for the site, the price or per-unit price of the addon can be set here. The value set for the addon\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\nis enabled.
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\n)
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
Resource object representing estimate
" } }, "required" : [ "estimate" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/estimates/create_invoice" : { "post" : { "summary" : "Create invoice estimate", "description" : "Generates an estimate for the 'create an invoice' operation. This is similar to the [Create an invoice](/docs/api/v2/pcv-1/invoices/create-an-invoice) API, but the invoice will not be generated. Only an estimate for this operation is created.\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\nfrom this invoice.
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.\ntaxes\nand\nline_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.
The ISO 3166-2 state/province 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).
The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
The price or per-unit-price of the addon. The value depends on the type of currency.
\nNote:
For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:
unit_price provided is $10The 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.
\nNote:
For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:
unit_price_in_decimal provided is $10.75Type of entity to which the note\nbelongs. To remove the general note, use the remove_general_note\nparameter.
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.
", "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
" } }, "required" : [ "estimate" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/subscriptions/{subscription-id}/cancel_subscription_estimate" : { "post" : { "summary" : "Cancel subscription estimate", "description" : "Generates an estimate for the 'cancel subscription' operation. This is similar to the [Cancel a subscription](/docs/api/v2/pcv-1/subscriptions/cancel-a-subscription) API, but the subscription will not be cancelled. Only an estimate for this operation is created.\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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" : "Determines when to cancel the subscription.
\nThis parameter is not applicable.
\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
(Deprecated) Use cancel_option instead.\nApplicable only when the subscription does not have 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.
Specifies the date and time when the subscription should be canceled. Do not use this parameter when end_of_term is set to true.
Applicable only when contract_term_cancel_option is specific_date. Specifies the date and time to cancel the subscription and contract term.
You can set a past date to backdate the cancellation. Backdating is allowed only if the following conditions are met:
\ncurrent_term_start.cancel_at cannot be earlier than February 14.Specifies how to handle credits for current term charges when canceling immediately (i.e., cancel_option is immediately). If not specified, the site-level setting is used.
Specifies how to handle credits for current term charges when contract_term_cancel_option is terminate_immediately. If not specified, the site-level setting is used.
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.
", "enum" : [ "none", "prorate", "full" ], "example" : null }, "unbilled_charges_option" : { "type" : "string", "deprecated" : false, "description" : "Specifies how to handle unbilled charges when canceling immediately (i.e., cancel_option is immediately). If not specified, the site-level setting is used.
Specifies how to handle unbilled charges when contract_term_cancel_option is terminate_immediately. If not specified, the site-level setting is used.
An invoice is generated immediately with the unbilled charges.
\n* delete -The unbilled charges are deleted.
", "enum" : [ "invoice", "delete" ], "example" : null }, "account_receivables_handling" : { "type" : "string", "deprecated" : false, "description" : "Specifies how to handle past due invoices when canceling immediately (i.e., cancel_option is immediately). If not specified, the site-level setting is used.
Specifies how to handle past due invoices when contract_term_cancel_option is terminate_immediately. If not specified, the site-level setting is used.
No action is taken.
\n* write_off -Applies excess payments and refundable credits to past due invoices. Any remaining balance is written off.\nNote: The credit note for the write-off is not included in the API response.
\n* schedule_payment_collection -Applies excess payments and refundable credits to past due invoices. If any amount remains and auto_collection\nis on\n, the remaining amount is automatically charged to the available payment method.
Specifies how to handle refundable credits when canceling immediately (i.e., cancel_option is immediately). If not specified, the site-level setting is used.
Specifies how to handle refundable credits when contract_term_cancel_option is terminate_immediately. If not specified, the site-level setting is used.
Refunds remaining credits after applying them to any past due invoices.
\n* no_action -No action is taken.
", "enum" : [ "no_action", "schedule_refund" ], "example" : null }, "contract_term_cancel_option" : { "type" : "string", "deprecated" : false, "description" : "Required when the subscription has a contract term. Determines when to cancel the subscription along with the contract term.
\n* terminate_immediately -Cancels the subscription and contract term immediately. Sets the contract term's status to terminated and collects any termination fee, if applicable.\nTo specify the termination fee, include a single object in the subscription_items array. If not specified, the default termination fee is applied (if configured).
Prevents the contract term from renewing and schedules the subscription for cancellation at the end of the contract term.
\n* specific_date -Cancels the subscription and contract term on the date specified by cancel_at. Sets action_at_term_end to cancel.\nNote: Contact Chargebee Support to enable this option for your Chargebee site.
Cancels the subscription and contract term at the end of the current billing cycle. Sets action_at_term_end to cancel.\nNote: Contact Chargebee Support to enable this option for your Chargebee site.
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:
invoice_date must be in the past.invoice_date is not more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.cancel_at.\n.The unique id\nof the event-based addon that represents the termination fee.
Resource object representing estimate
" } }, "required" : [ "estimate" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/quotes/{quote-id}/edit_one_time_quote" : { "post" : { "summary" : "Edit quote for one-time charges", "description" : "Edits a quote. The quote must be for [one-time charges](https://www.chargebee.com/docs/charges.html#one-time-charges) or [non-recurring addons](https://www.chargebee.com/docs/charges.html#non-recurring-addon).\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
The price or per-unit-price of the addon. The value depends on the type of currency.
\nNote:
For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:
unit_price provided is $10The 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.
\nNote:
For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:
unit_price_in_decimal provided is $10.75Specifies the service period of the addon in days. When the quote is converted, the invoice.line_item.date_from\nis set to current date/time and invoice.line_item.date_to\nis set to service_period\ndays ahead of date_from\n.
Resource object representing quote
" }, "quoted_charge" : { "$ref" : "#/components/schemas/QuotedCharge", "description" : "Resource object representing quoted_charge
" } }, "required" : [ "quote" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/quotes/{quote-id}" : { "get" : { "summary" : "Retrieve a quote", "description" : "Important\nFor sites where both legacy and latest 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.
Override options:
chargebee-response-schema-type: items → Return response in latest product catalog format only.chargebee-response-schema-type: plans_addons → Return response in legacy product catalog format only.Retrieves the quotes identified by the `number` specified in the URL.
Resource object representing quote
" }, "quoted_subscription" : { "$ref" : "#/components/schemas/QuotedSubscription", "description" : "Resource object representing quoted_subscription
" }, "quoted_charge" : { "$ref" : "#/components/schemas/QuotedCharge", "description" : "Resource object representing quoted_charge
" }, "quoted_ramp" : { "$ref" : "#/components/schemas/QuotedRamp", "description" : "" } }, "required" : [ "quote" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/quotes/update_subscription_quote" : { "post" : { "summary" : "Create quote for updating a subscription", "description" : "Creates a quote for updating a subscription under the customer specified.\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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.\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.
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.\nNote:\nIt is recommended not to pass this parameter along with changed_scheduled_at.\nreactivate_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:
changes_scheduled_at cannot be earlier than 14th February.\n.When the quote is converted, this attribute determines the date/time as of when the subscription change is to be carried out.
\n* specific_date -The change is carried out as of the date specified under changes_scheduled_at\n.
The change is carried out immediately.
", "enum" : [ "immediately", "specific_date" ], "example" : null }, "changes_scheduled_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "When change_option\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:
Backdating must be enabled for subscription change operations.
\nOnly the following changes can be backdated:
\nChanges in the recurring items or their prices.
\nAddition of non-recurring items.
\nSubscription status is active, cancelled, or non_renewing.
The current day of the month does not exceed the limit set in Chargebee for backdating subscription change. This limit is the day of the month by which the accounting for the previous month must be closed.
\nThe date is on or after current_term_start.
The date is on or after the last date/time any of the following changes were made:
\nChanges in the recurring items or their prices.
\nAddition of non-recurring items.
\nThe 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..
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.
The new start date of a future\nsubscription. Applicable only for future\nsubscriptions.
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.\nNote:\nThis parameter can be backdated (set to a value in the past) only when the subscription is in cancelled\nor in_trial\nstatus.\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.
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\n.
The ISO 3166-2 state/province 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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The ISO 3166-2 state/province 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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
An overridden value for the first two characters of the full VAT number.\nOnly applicable specifically for customers with billing_address
country\nas XI\n(which is United Kingdom - Northern Ireland\n).
When you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, you have the option of setting billing_address
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\nXI\nby default. However, if the VAT number was registered in UK, the value should be GB.\nSet\nvat_number_prefix\nto GB\nfor such cases.
Confirms that a customer is registered under GST. If set to true\nthen the Reverse Charge Mechanism\nis applicable. This field is applicable only when Australian GST is configured for your site.
Action to be taken when the contract term completes.
\n* evergreen -Contract term completes and the subscription renews.
\n* renew -contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.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.
action_at_term_end for the new contract term is set to cancel.Contract term completes and subscription is canceled.
", "enum" : [ "renew", "evergreen", "cancel", "renew_once" ], "example" : null }, "cancellation_cutoff_period" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The number of days before contract_end\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.
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
The price or per-unit-price of the addon. The value depends on the type of currency.
\nNote:
For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:
unit_price provided is $10When price overriding\nis enabled for the site, the price or per-unit price of the addon can be set here. The value set for the addon\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\nis enabled.
The time at which the trial ends for the addon. To update this value, redo the complete addon set using replace_addon_list.\n(Addon trial periods must be enabled by Chargebee Support\n.)
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
Resource object representing quote
" }, "quoted_subscription" : { "$ref" : "#/components/schemas/QuotedSubscription", "description" : "Resource object representing quoted_subscription
" } }, "required" : [ "quote" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/quotes/create_for_onetime_charges" : { "post" : { "summary" : "Create quote for one-time charges", "description" : "Creates a quote for [one-time charges](https://www.chargebee.com/docs/charges.html#one-time-charges) and [non-recurring addons](https://www.chargebee.com/docs/charges.html#non-recurring-addon). This is applicable only for one-time payment. Recurring charges are not permitted in this quote; use [Create quote for a new subscription](/docs/api/v2/pcv-1/quotes/create-quote-for-a-new-subscription) or [Create quote for updating a subscription](/docs/api/v2/pcv-1/quotes/create-quote-for-updating-a-subscription) instead.\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
The price or per-unit-price of the addon. The value depends on the type of currency.
\nNote:
For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:
unit_price provided is $10The 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.
\nNote:
For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:
unit_price_in_decimal provided is $10.75Specifies the service period of the addon in days. When the quote is converted, the invoice.line_item.date_from\nis set to current date/time and invoice.line_item.date_to\nis set to service_period\ndays ahead of date_from\n.
Resource object representing quote
" }, "quoted_charge" : { "$ref" : "#/components/schemas/QuotedCharge", "description" : "Resource object representing quoted_charge
" } }, "required" : [ "quote" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/quotes/{quote-id}/update_status" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\\* accepted -\n\nAccepted.\n\\* closed -\n\nClosed\n\\* declined -\n\nDeclined.\n\\* proposed - \\* 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
" }, "quoted_subscription" : { "$ref" : "#/components/schemas/QuotedSubscription", "description" : "Resource object representing quoted_subscription
" }, "quoted_charge" : { "$ref" : "#/components/schemas/QuotedCharge", "description" : "Resource object representing quoted_charge
" }, "quoted_ramp" : { "$ref" : "#/components/schemas/QuotedRamp", "description" : "" } }, "required" : [ "quote" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/create_subscription_quote" : { "post" : { "summary" : "Create quote for a new subscription", "description" : "Creates a quote for a new subscription under the customer specified.\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\\* delayed -\n\nSubscription period will be aligned with the configured billing date at the next renewal.\n\\* immediate -\n\nSubscription 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:
\nsubscription[start_date] cannot be earlier than 14th February.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\n.
The ISO 3166-2 state/province 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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
Action to be taken when the contract term completes.
\n* evergreen -Contract term completes and the subscription renews.
\n* renew -contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.Contract term completes and subscription is canceled.
", "enum" : [ "renew", "evergreen", "cancel" ], "example" : null }, "cancellation_cutoff_period" : { "type" : "integer", "format" : "int32", "default" : 0, "deprecated" : false, "description" : "The number of days before contract_end\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.
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
The price or per-unit-price of the addon. The value depends on the type of currency.
\nNote:
For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:
unit_price provided is $10When price overriding\nis enabled for the site, the price or per-unit price of the addon can be set here. The value set for the addon\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\nis enabled.
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\n)
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
Resource object representing quote
" }, "quoted_subscription" : { "$ref" : "#/components/schemas/QuotedSubscription", "description" : "Resource object representing quoted_subscription
" } }, "required" : [ "quote" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/quotes/{quote-id}/quote_line_groups" : { "get" : { "summary" : "List quote line groups", "description" : "This API retrieves all the quote line groups and lineitems for a quote.\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "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.
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.
The number of subscription billing cycles to invoice in advance.\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.
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.\nNote:\nIt is recommended not to pass this parameter along with changed_scheduled_at.\nreactivate_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:
changes_scheduled_at cannot be earlier than 14th February.\n.When the quote is converted, this attribute determines the date/time as of when the subscription change is to be carried out.
\n* specific_date -The change is carried out as of the date specified under changes_scheduled_at\n.
The change is carried out immediately.
", "enum" : [ "immediately", "specific_date" ], "example" : null }, "changes_scheduled_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "When change_option\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:
Backdating must be enabled for subscription change operations.
\nOnly the following changes can be backdated:
\nChanges in the recurring items or their prices.
\nAddition of non-recurring items.
\nSubscription status is active, cancelled, or non_renewing.
The current day of the month does not exceed the limit set in Chargebee for backdating subscription change. This limit is the day of the month by which the accounting for the previous month must be closed.
\nThe date is on or after current_term_start.
The date is on or after the last date/time any of the following changes were made:
\nChanges in the recurring items or their prices.
\nAddition of non-recurring items.
\nThe 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.
The new start date of a future\nsubscription. Applicable only for future\nsubscriptions.
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.\nNote:\nThis parameter can be backdated (set to a value in the past) only when the subscription is in cancelled\nor in_trial\nstatus.\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.
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\n.
The ISO 3166-2 state/province 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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The ISO 3166-2 state/province 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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
An overridden value for the first two characters of the full VAT number.\nOnly applicable specifically for customers with billing_address
country\nas XI\n(which is United Kingdom - Northern Ireland\n).
When you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, you have the option of setting billing_address
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\nXI\nby default. However, if the VAT number was registered in UK, the value should be GB.\nSet\nvat_number_prefix\nto GB\nfor such cases.
Confirms that a customer is registered under GST. If set to true\nthen the Reverse Charge Mechanism\nis applicable. This field is applicable only when Australian GST is configured for your site.
Action to be taken when the contract term completes.
\n* evergreen -Contract term completes and the subscription renews.
\n* renew -contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.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.
action_at_term_end for the new contract term is set to cancel.Contract term completes and subscription is canceled.
", "enum" : [ "renew", "evergreen", "cancel", "renew_once" ], "example" : null }, "cancellation_cutoff_period" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "The number of days before contract_end\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.
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
The price or per-unit-price of the addon. The value depends on the type of currency.
\nNote:
For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:
unit_price provided is $10When price overriding\nis enabled for the site, the price or per-unit price of the addon can be set here. The value set for the addon\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\nis enabled.
The time at which the trial ends for the addon. To update this value, redo the complete addon set using replace_addon_list.\n(Addon trial periods must be enabled by Chargebee Support\n.)
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
Resource object representing quote
" }, "quoted_subscription" : { "$ref" : "#/components/schemas/QuotedSubscription", "description" : "Resource object representing quoted_subscription
" } }, "required" : [ "quote" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/quotes/{quote-id}/extend_expiry_date" : { "post" : { "summary" : "Extend expiry date", "description" : "Can be used to extend the expiry date of a quote.\n", "operationId" : "extend_expiry_date", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" }, "quoted_subscription" : { "$ref" : "#/components/schemas/QuotedSubscription", "description" : "Resource object representing quoted_subscription
" }, "quoted_charge" : { "$ref" : "#/components/schemas/QuotedCharge", "description" : "Resource object representing quoted_charge
" }, "quoted_ramp" : { "$ref" : "#/components/schemas/QuotedRamp", "description" : "" } }, "required" : [ "quote" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/quotes/{quote-id}/edit_create_subscription_quote" : { "post" : { "summary" : "Edit quote for a new subscription", "description" : "Edits a quote. This endpoint is for quotes that are for new subscriptions. To edit a quote that is for updating a subscription, use [Edit quote for updating a subscription](/docs/api/v2/pcv-1/quotes/edit-quote-for-updating-a-subscription).\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\\* delayed -\n\nSubscription period will be aligned with the configured billing date at the next renewal.\n\\* immediate -\n\nSubscription 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:
\nsubscription[start_date] cannot be earlier than 14th February.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\n.
The ISO 3166-2 state/province 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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
Action to be taken when the contract term completes.
\n* evergreen -Contract term completes and the subscription renews.
\n* renew -contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.Contract term completes and subscription is canceled.
", "enum" : [ "renew", "evergreen", "cancel" ], "example" : null }, "cancellation_cutoff_period" : { "type" : "integer", "format" : "int32", "default" : 0, "deprecated" : false, "description" : "The number of days before contract_end\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.
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
The price or per-unit-price of the addon. The value depends on the type of currency.
\nNote:
For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:
unit_price provided is $10When price overriding\nis enabled for the site, the price or per-unit price of the addon can be set here. The value set for the addon\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\nis enabled.
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\n)
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
Resource object representing quote
" }, "quoted_subscription" : { "$ref" : "#/components/schemas/QuotedSubscription", "description" : "Resource object representing quoted_subscription
" } }, "required" : [ "quote" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/quotes" : { "get" : { "summary" : "List quotes", "description" : "Important\nFor sites where both legacy and latest 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.
Override options:
chargebee-response-schema-type: items → Return response in latest product catalog format only.chargebee-response-schema-type: plans_addons → Return response in legacy product catalog format only.List all quotes.
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.
Resource object representing quote
" }, "quoted_subscription" : { "$ref" : "#/components/schemas/QuotedSubscription", "description" : "Resource object representing quoted_subscription
" }, "quoted_ramp" : { "$ref" : "#/components/schemas/QuotedRamp", "description" : "" } }, "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.
Resource object representing download
" } }, "required" : [ "download" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/quotes/{quote-id}/convert" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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:
invoice_date must be in the past.invoice_date is not more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.quoted_subscription.start_date or quoted_subscription.changes_scheduled_at (whichever is applicable).invoice_immediately must be true.\n.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.\nThe default value is as per the site settings\n.
\nNote:\ninvoice_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.
.
", "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\\* off -\n\nAutomatic collection of charges will not be made for this subscription. Use this for offline payments.\n\\* on -\n\nWhenever 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
" }, "quoted_subscription" : { "$ref" : "#/components/schemas/QuotedSubscription", "description" : "Resource object representing quoted_subscription
" }, "quoted_charge" : { "$ref" : "#/components/schemas/QuotedCharge", "description" : "Resource object representing quoted_charge
" }, "quoted_ramp" : { "$ref" : "#/components/schemas/QuotedRamp", "description" : "" }, "customer" : { "$ref" : "#/components/schemas/Customer", "description" : "Resource object representing customer
" }, "subscription" : { "$ref" : "#/components/schemas/Subscription", "description" : "Resource object representing subscription
" }, "invoice" : { "$ref" : "#/components/schemas/Invoice", "description" : "Resource object representing invoice
" }, "credit_note" : { "$ref" : "#/components/schemas/CreditNote", "description" : "Resource object representing credit_note
" }, "unbilled_charges" : { "type" : "array", "description" : "Resource object representing unbilled_charge
", "items" : { "$ref" : "#/components/schemas/UnbilledCharge", "description" : "Resource object representing unbilled_charge" }, "example" : null } }, "required" : [ "customer", "quote" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/quotes/{quote-id}/delete" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" }, "quoted_subscription" : { "$ref" : "#/components/schemas/QuotedSubscription", "description" : "Resource object representing quoted_subscription
" }, "quoted_charge" : { "$ref" : "#/components/schemas/QuotedCharge", "description" : "Resource object representing quoted_charge
" }, "quoted_ramp" : { "$ref" : "#/components/schemas/QuotedRamp", "description" : "" } }, "required" : [ "quote" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/plans/{plan-id}/unarchive" : { "post" : { "summary" : "Unarchive a plan", "description" : "This endpoint unarchives a specific plan which was archived\nearlier.
Resource object representing plan
" } }, "required" : [ "plan" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/plans/{plan-id}/delete" : { "post" : { "summary" : "Delete a plan", "description" : "Deletes or archives a plan. This endpoint behaves differently based on the scenarios listed below:
archived state. Subscriptions already on it continue to renew. However, until the plan is unarchived,\nResource object representing plan
" } }, "required" : [ "plan" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/plans/copy" : { "post" : { "summary" : "Copy a plan", "description" : "Creates a plan in this site by copying its configurations from another site. Copying of archived plans is not supported. \n**Note:**\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "plan" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/plans" : { "get" : { "summary" : "List plans", "description" : "This API fetches all the active and archived plans. If the limit parameter is not set, it will return upto 10 plans.
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.
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.
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\nis enabled. .
Used exclusively with the following accounting integrations
\n: . For example:Location: Singapore.::...: : .... For example: Services : Plan.Used exclusively with the following accounting integrations
\n: .... For example, Region: South::.... For example: Location: North America: Canada: : .... For example: NA:US:CAUsed exclusively with the following accounting integrations
\n: : .... For example: Production: Assembly.Whether the plan.description\nshould be shown on invoice PDFs.\nIf this Boolean is changed, only invoices generated (or regenerated\n)after the change are affected; past invoices are not.
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\n.
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\nis enabled.
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\nis enabled.
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\nis enabled.
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
Resource object representing plan
" } }, "required" : [ "plan" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/plans/{plan-id}" : { "get" : { "summary" : "Retrieve a plan", "description" : "This endpoint retrieves a specific plan using the plan ID.\n", "operationId" : "retrieve_a_plan", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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
" } }, "required" : [ "plan" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] }, "post" : { "summary" : "Update a plan", "description" : "When updating plans that are already linked to an invoice or a subscription, you can only update the following parameters:\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\\* month -\n\nIn months\n\\* day -\n\nIn 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\\* cancel_subscription -\n\nThe subscription cancels.\n\\* activate_subscription -\n\nThe subscription activates and charges are raised for non-metered items.\n\\* site_default -\n\nThe 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)\nat 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\\* month -\n\nCharge based on month(s)\n\\* day -\n\nCharge based on day(s)\n\\* week -\n\nCharge based on week(s)\n\\* year -\n\nCharge 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\nis enabled. .
Used exclusively with the following accounting integrations
\n: . For example:Location: Singapore.::...: : .... For example: Services : Plan.Used exclusively with the following accounting integrations
\n: .... For example, Region: South::.... For example: Location: North America: Canada: : .... For example: NA:US:CAUsed exclusively with the following accounting integrations
\n: : .... For example: Production: Assembly.Whether the plan.description\nshould be shown on invoice PDFs.\nIf this Boolean is changed, only invoices generated (or regenerated\n)after the change are affected; past invoices are not.
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\n.
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\nis enabled.
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\nis enabled.
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\nis enabled.
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
Resource object representing plan
" } }, "required" : [ "plan" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/addons/copy" : { "post" : { "summary" : "Copy an addon", "description" : "Creates an addon in this site by copying its configurations from another site. Copying of archived addons is not supported. \n**Note:**\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "addon" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/addons/{addon-id}/unarchive" : { "post" : { "summary" : "Unarchive an addon", "description" : "Unarchives a specific addon using the id.\n", "operationId" : "unarchive_an_addon", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "addon" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/addons/{addon-id}" : { "get" : { "summary" : "Retrieve an addon", "description" : "Retrieve a specific addon using the ID.\n", "operationId" : "retrieve_an_addon", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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
" } }, "required" : [ "addon" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] }, "post" : { "summary" : "Update an addon", "description" : "When updating addons that already have an invoice or a subscription linked to it, you can only update the following parameters:\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\\* non_recurring -\n\nCharged immediately and only once every time it is applied.\n\\* recurring -\n\nCharges 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\\* month -\n\nCharge based on month(s)\n\\* week -\n\nCharge based on week(s)\n\\* not_applicable -\n\nnot applicable for this addon\n\\* year -\n\nCharge based on year(s)\n\\* day -\n\nCharge 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\\* tiered -\n\nThere are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.\n\\* per_unit -\n\nA fixed price per unit quantity.\n\\* flat_fee -\n\nA fixed price that is not quantity-based.\n\\* volume -\n\nThe per unit price is based on the tier that the total quantity falls in.\n\\* stairstep -\n\nA 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\\* retail -\n\nTransaction is a sale to an end user\n\\* vendor_use -\n\nTransaction is for an item that is subject to vendor use tax\n\\* wholesale -\n\nTransaction is a sale to another company that will resell your product or service to another consumer\n\\* consumed -\n\nTransaction 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. \\*\\*Note:\\*\\* There's a character limit of 65,535. \\[Learn more\\](/docs/api/v2/pcv-1/advanced-features) .\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
\n: . For example:Location: Singapore.::...: : .... For example: Services : Plan.Used exclusively with the following accounting integrations
\n: .... For example, Region: South::.... For example: Location: North America: Canada: : .... For example: NA:US:CAUsed exclusively with the following accounting integrations
\n: : .... For example: Production: Assembly.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.
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\nis enabled.
This 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.
Note\nApplicable only for addons with pricing_model = per_unit.
Specifies how to manage charges or credits for the addon during a subscription update\nor estimating\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 -Use the site-wide proration setting\n.
\n* partial_term -Prorate the charges or credits for the rest of the current term.
", "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\n.
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\nis enabled.
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\nis enabled.
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\nis enabled.
Resource object representing addon
" } }, "required" : [ "addon" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/addons" : { "get" : { "summary" : "List addons", "description" : "List the addons. This returns all your current active and archived addons.\n", "operationId" : "list_addons", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "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.
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.
Used exclusively with the following accounting integrations
\n: . For example:Location: Singapore.::...: : .... For example: Services : Plan.Used exclusively with the following accounting integrations
\n: .... For example, Region: South::.... For example: Location: North America: Canada: : .... For example: NA:US:CAUsed exclusively with the following accounting integrations
\n: : .... For example: Production: Assembly.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.
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\nis enabled.
This 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.
Note\nApplicable only for addons with pricing_model = per_unit.
Specifies how to manage charges or credits for the addon during a subscription update\nor estimating\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 -Use the site-wide proration setting\n.
\n* partial_term -Prorate the charges or credits for the rest of the current term.
", "enum" : [ "site_default", "partial_term", "full_term" ], "example" : null }, "status" : { "type" : "string", "default" : "active", "deprecated" : false, "description" : "Status of the addon.\n\\* archived -\n\nNo new associations with subscriptions are allowed. Existing associations for recurring addons remain as-is and can be removed if required.\n\\* active -\n\nOnly 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\n.
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\nis enabled.
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\nis enabled.
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\nis enabled.
Resource object representing addon
" } }, "required" : [ "addon" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/addons/{addon-id}/delete" : { "post" : { "summary" : "Delete an addon", "description" : "When an addon that already has subscriptions/invoices linked to it is deleted, it does not get completely purged but is instead moved to \"Archived\" state. No other subscriptions can use this addon but subscriptions already on it will continue to renew. Once an addon has been archived, it cannot be edited or used again and the addon cannot be un-archived.\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "addon" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/coupons" : { "get" : { "summary" : "List coupons", "description" : "Important\nFor sites where both legacy and latest 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.
Override options:
chargebee-response-schema-type: items → Return response in latest product catalog format only.chargebee-response-schema-type: plans_addons → Return response in legacy product catalog format only.List all the available coupons that are created for a specific promotion or offers. You can find list of coupon codes that are currently active, expired, archived or deleted.
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.
optional, string filter
\nUsed to uniquely identify the coupon in your website/application and to integrate with Chargebee.
\nNote:
When the coupon ID contains a special character; for example: #, the API returns an error. Make sure that you encode the coupon ID in the path parameter before making an API call.
.\nSupported operators :\nis, is_not, starts_with, in, not_in
\nExample →\nid[is] = "OFF2008"
", "required" : false, "deprecated" : false, "style" : "deepObject", "explode" : true, "schema" : { "type" : "object", "deprecated" : false, "example" : "OFF2008", "properties" : { "is" : { "type" : "string", "minLength" : 1, "example" : null }, "is_not" : { "type" : "string", "minLength" : 1, "example" : null }, "starts_with" : { "type" : "string", "minLength" : 1, "example" : null }, "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "not_in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null } } } }, { "name" : "name", "in" : "query", "description" : "optional, string filter
\nThe display name used in web interface for identifying the coupon.
\nNote:
When the name of the coupon set contains a special character; for example: #, the API returns an error. Make sure that you encode the name of the coupon set in the path parameter before making an API call.
.\nSupported operators :\nis, is_not, starts_with, in, not_in
\nExample →\nname[is] = "Offer 10"
", "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. \\* \\`percentage\\` - The specified percentage will be deducted. \\* \\`offer_quantity\\` - The specified units will be offered without any deduction.\n", "enum" : [ "fixed_amount", "percentage", "offer_quantity" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`fixed_amount\\` - The specified amount will be deducted. \\* \\`percentage\\` - The specified percentage will be deducted. \\* \\`offer_quantity\\` - The specified units will be offered without any deduction.\n", "enum" : [ "fixed_amount", "percentage", "offer_quantity" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`fixed_amount\\` - The specified amount will be deducted. \\* \\`percentage\\` - The specified percentage will be deducted. \\* \\`offer_quantity\\` - The specified units will be offered without any deduction.\n", "enum" : [ "fixed_amount", "percentage", "offer_quantity" ], "pattern" : "^\\[(fixed_amount|percentage|offer_quantity)(,(fixed_amount|percentage|offer_quantity))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`fixed_amount\\` - The specified amount will be deducted. \\* \\`percentage\\` - The specified percentage will be deducted. \\* \\`offer_quantity\\` - The specified units will be offered without any deduction.\n", "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 byperiod and period_unit. ",
"enum" : [ "one_time", "forever", "limited_period" ],
"example" : null
},
"is_not" : {
"type" : "string",
"description" : "* `one_time` - The coupon stays attached to the subscription till it is applied on an invoice once. It is removed after that from the subscription.\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. ",
"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. ",
"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. ",
"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 or 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.",
"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 or 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.",
"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 or 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.",
"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 or 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.",
"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` - invoice.line_item.amount that corresponds to the item price specified by item_price_id.\ninvoice.line_item.amount that corresponds to the plan or addon specified by plan_ids and addon_ids.\nsub_total.\n* `specified_items_total` - **(Deprecated)** Discount will be applied to the total of plan and addon items specified.\n* `each_specified_item` - invoice.line_item.amount that corresponds to the item price specified by item_price_id.\ninvoice.line_item.amount that corresponds to the plan or addon specified by plan_ids and addon_ids.\nsub_total.\n* `specified_items_total` - **(Deprecated)** Discount will be applied to the total of plan and addon items specified.\n* `each_specified_item` - invoice.line_item.amount that corresponds to the item price specified by item_price_id.\ninvoice.line_item.amount that corresponds to the plan or addon specified by plan_ids and addon_ids.\nsub_total.\n* `specified_items_total` - **(Deprecated)** Discount will be applied to the total of plan and addon items specified.\n* `each_specified_item` - invoice.line_item.amount that corresponds to the item price specified by item_price_id.\ninvoice.line_item.amount that corresponds to the plan or addon specified by plan_ids and addon_ids.\nThis attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter offset.
Used to uniquely identify the coupon in your website/application and to integrate with Chargebee.
\nNote:
When the coupon ID contains a special character; for example: #, the API returns an error. Make sure that you encode the coupon ID in the path parameter before making an API call.
.
", "maxLength" : 100, "example" : null }, "name" : { "type" : "string", "deprecated" : false, "description" : "The display name used in web interface for identifying the coupon.
\nNote:
When the name of the coupon set contains a special character; for example: #, the API returns an error. Make sure that you encode the name of the coupon set in the path parameter before making an API call.
.
", "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* fixed_amount -A fixed amount is deducted as a discount. The discount amount is specified in discount_amount.
Learn more\nabout fixed_amount\ncoupons.
A percentage of the original price is deducted as a discount. The discount percentage is specified in discount_percentage.
Learn more\nabout percentage\ncoupons.
A specified number of units of the plan or addon are offered for free. The number of free units is specified in discount_quantity.\nThe offer_quantity\noption is valid only when apply_on\nis set to each_specified_item\nand the pricing_model\nof the plan\nor addon is per_unit.
Learn more\nabout offer_quantity\ncoupons.
Specifies the number of free units provided for the plan\nor addon\n, without affecting the total quantity sold. This parameter is applicable only when the discount_type\nis set to offer_quantity\n.
The amount on the invoice to which the coupon is applied.
\n* invoice_amount -The coupon is applied to the invoice sub_total\n.
The coupon is applied to the invoice.line_item.amount\nthat corresponds to the plan or addon specified by plan_ids\nand addon_ids\n.
Specifies the time duration for which this coupon is attached to 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\nand period_unit\n.
The coupon stays attached to the subscription till it is applied on an invoice once.\nIt is removed after that from the subscription.
", "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.
Note:\nThis parameter has been deprecated. Use period\nand period_unit\ninstead.
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.
The duration of time for which the coupon is attached to the subscription, in period_units.\nApplicable only when duration_type\nis limited_period\n.
The unit of time for period. Applicable only when duration_type\nis limited_period\n.
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.
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "plan_constraint" : { "type" : "string", "deprecated" : false, "description" : "Plans the coupon can be applied to.\n\\* all -\n\nCoupon applicable to all plans.\n\\* specific -\n\nCoupon only applicable to specified plans. If used, it is mandatory to specify the plan(s).\n\\* none -\n\nCoupon 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\\* specific -\n\nCoupon only applicable to specified addons. If used, it is mandatory to specify the addon(s).\n\\* all -\n\nCoupon applicable to all addons.\n\\* none -\n\nCoupon 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\\* active -\n\nCan be applied to a subscription.\n\\* archived -\n\nCannot 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
" } }, "required" : [ "coupon" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/coupons/{coupon-id}/unarchive" : { "post" : { "summary" : "Unarchive a coupon", "description" : "This API unarchives a specific coupon using the coupon ID.\n", "operationId" : "unarchive_a_coupon", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "coupon" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/coupons/{coupon-id}/delete" : { "post" : { "summary" : "Delete a coupon", "description" : "If no Subscriptions/Invoices are linked to this Coupon, the Coupon will be deleted from your Chargebee site. This action cannot be undone.\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "coupon" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/coupons/copy" : { "post" : { "summary" : "Copy a coupon", "description" : "Creates a coupon in this site by copying its configurations from another site. Copying of archived coupons is not supported. \n**Note:**\n\n* The plans and addons (refer plan_constraint, plan_ids, addon_constraint, addon_ids) that are linked will also be copied. E.g. in the source site, the coupon C1 has P1 and P2 as applicable plans. Now, if in the destination site only the plan P1 is present, the newly created coupon will have only P1 as the applicable plan. So we recommend that you copy the necessary plans and addons before copying the coupons.\n* The 'redemptions' count is not copied. It will be 0 for the newly created coupon. Hence, if you are copying a Expired coupon (expired because max_redemptions is reached), its status will be 'Active' when created.\n", "operationId" : "copy_a_coupon", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "coupon" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/coupons/{coupon-id}" : { "get" : { "summary" : "Retrieve a coupon", "description" : "Important\nFor sites where both legacy and latest 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.
Override options:
chargebee-response-schema-type: items → Return response in latest product catalog format only.chargebee-response-schema-type: plans_addons → Return response in legacy product catalog format only.This API retrieves a specific coupon using the coupon ID.
Resource object representing coupon
" } }, "required" : [ "coupon" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] }, "post" : { "summary" : "Update a coupon", "description" : "When updating coupons that are already linked to an invoice or subscription you can only update the following parameters:\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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.
\nNote:
When the name of the coupon set contains a special character; for example: #, the API returns an error. Make sure that you encode the name of the coupon set in the path parameter before making an API call.
.
", "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* fixed_amount -A fixed amount is deducted as a discount. The discount amount is specified in discount_amount.
Learn more\nabout fixed_amount\ncoupons.
A percentage of the original price is deducted as a discount. The discount percentage is specified in discount_percentage.
Learn more\nabout percentage\ncoupons.
A specified number of units of the plan or addon are offered for free. The number of free units is specified in discount_quantity.\nThe offer_quantity\noption is valid only when apply_on\nis set to each_specified_item\nand the pricing_model\nof the plan\nor addon is per_unit.
Learn more\nabout offer_quantity\ncoupons.
Specifies the number of free units provided for the plan\nor addon\n, without affecting the total quantity sold. This parameter is applicable only when the discount_type\nis set to offer_quantity\n.
The amount on the invoice to which the coupon is applied.
\n* invoice_amount -The coupon is applied to the invoice sub_total\n.
The coupon is applied to the invoice.line_item.amount\nthat corresponds to the plan or addon specified by plan_ids\nand addon_ids\n.
Specifies the time duration for which this coupon is attached to 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\nand period_unit\n.
The coupon stays attached to the subscription till it is applied on an invoice once.\nIt is removed after that from the subscription.
", "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.
Note:\nThis parameter has been deprecated. Use period\nand period_unit\ninstead.
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.
The duration of time for which the coupon is attached to the subscription, in period_units.\nApplicable only when duration_type\nis limited_period\n.
The unit of time for period. Applicable only when duration_type\nis limited_period\n.
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.
", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "plan_constraint" : { "type" : "string", "deprecated" : false, "description" : "Plans the coupon can be applied to.\n\\* all -\n\nCoupon applicable to all plans.\n\\* specific -\n\nCoupon only applicable to specified plans. If used, it is mandatory to specify the plan(s).\n\\* none -\n\nCoupon 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\\* specific -\n\nCoupon only applicable to specified addons. If used, it is mandatory to specify the addon(s).\n\\* all -\n\nCoupon applicable to all addons.\n\\* none -\n\nCoupon 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
" } }, "required" : [ "coupon" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/coupon_sets" : { "get" : { "summary" : "List coupon sets", "description" : "Use this API to get the list of all the coupon sets.\n", "operationId" : "list_coupon_sets", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "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.
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.
Resource object representing coupon_set
" } }, "required" : [ "coupon_set" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/coupon_sets/{coupon-set-id}/update" : { "post" : { "summary" : "Update a coupon set", "description" : "Use this API to update a specific coupon set by updating its name and the meta_data.
Resource object representing coupon_set
" } }, "required" : [ "coupon_set" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/coupon_sets/{coupon-set-id}" : { "get" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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
" } }, "required" : [ "coupon_set" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/coupon_sets/{coupon-set-id}/add_coupon_codes" : { "post" : { "summary" : "Add coupon codes to coupon set", "description" : "This API add coupon codes to an existing coupon set.\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "coupon_set" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/coupon_sets/{coupon-set-id}/delete_unused_coupon_codes" : { "post" : { "summary" : "Delete unused coupon codes", "description" : "Use this API to delete all the unutilised coupon codes from a specific coupon set.\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "coupon_set" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/coupon_sets/{coupon-set-id}/delete" : { "post" : { "summary" : "Delete a coupon set", "description" : "Use this endpoint to delete a specific coupon set\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "coupon_set" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/coupon_codes" : { "get" : { "summary" : "List coupon codes", "description" : "List the available coupon codes.\n", "operationId" : "list_coupon_codes", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "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.
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.
Resource object representing coupon_code
" } }, "required" : [ "coupon_code" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/coupon_codes/{coupon-code-code}/archive" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "coupon_code" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/addresses" : { "get" : { "summary" : "Retrieve an address", "description" : "Retrieves an address resource for a subscription and the specified label.\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-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
" } }, "required" : [ "address" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] }, "post" : { "summary" : "Update an address", "description" : "Adds or replaces the address for a subscription. If an address is already present for the specified label, it will be replaced otherwise new address is added with that label.\n", "operationId" : "update_an_address", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\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).
The state/province name. Is set by Chargebee automatically for US, Canada, India and UAE, if state_code\nis provided.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
.
", "maxLength" : 50, "example" : null }, "validation_status" : { "type" : "string", "default" : "not_validated", "deprecated" : false, "description" : "The address verification status.\n\\* partially_valid -\n\nThe address is valid for taxability but has not been validated for shipping.\n\\* not_validated -\n\nAddress is not yet validated.\n\\* invalid -\n\nAddress is invalid.\n\\* valid -\n\nAddress 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
" } }, "required" : [ "address" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/events" : { "get" : { "summary" : "List events", "description" : "Retrieves list of events.\n", "operationId" : "list_events", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "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.
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.
Resource object representing event
" } }, "required" : [ "event" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/comments/{comment-id}/delete" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "comment" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/comments/{comment-id}" : { "get" : { "summary" : "Retrieve a comment", "description" : "Retrieve a comment for an entity identified by comment ID.\n", "operationId" : "retrieve_a_comment", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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
" } }, "required" : [ "comment" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/comments" : { "get" : { "summary" : "List comments", "description" : "Retrieve the list of comments sorted by the recent ones on the top.\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "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.
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.
Resource object representing comment
" } }, "required" : [ "comment" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/portal_sessions" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "portal_session" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/portal_sessions/{portal-session-id}/activate" : { "post" : { "summary" : "Activate a portal session", "description" : "When an user is sent back to your return URL with session details, you should validate that information by calling this API. The details passed to the **return_url** should be sent as below:\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "portal_session" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/portal_sessions/{portal-session-id}/logout" : { "post" : { "summary" : "Logout a portal session", "description" : "Logs out the portal session. Typically this should be called when customers logout of your application.\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "portal_session" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/portal_sessions/{portal-session-id}" : { "get" : { "summary" : "Retrieve a portal session", "description" : "This API retrieves a portal session using portal_session_id\nas a path parameter.
Resource object representing portal_session
" } }, "required" : [ "portal_session" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/site_migration_details" : { "get" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "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.
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.
Resource object representing resource_migration
" } }, "required" : [ "resource_migration" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/time_machines/{time-machine-name}" : { "get" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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
" } }, "required" : [ "time_machine" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/time_machines/{time-machine-name}/travel_forward" : { "post" : { "summary" : "Travel forward", "description" : "Travel forward in time. This operation is **asynchronous**\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "time_machine" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/time_machines/{time-machine-name}/start_afresh" : { "post" : { "summary" : "Start afresh", "description" : "Restart the time machine. This will clear the \"customer\" data like customer details, subscriptions, invoices, transactions. Also a time travel is initiated to travel back to specified genesis time.\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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
" } }, "required" : [ "time_machine" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/exports/customers" : { "post" : { "summary" : "Export customers", "description" : "This API triggers export of customer data. The exported zip file contains CSV files with customer-related data.\n", "operationId" : "export_customers", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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* data -Provides the full set of data for the customers in multiple .csv files.
Provides a .csv file whose columns match the customer schema. This file format can be readily imported through the UI by using Bulk Operations.
entity_code or exempt_number attributes if you use Chargebee’s AvaTax for Sales or specify exemption_details attribute if you use Chargebee’s AvaTax for Communications 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.entity_code or exempt_number attributes if you use Chargebee’s AvaTax for Sales or specify exemption_details attribute if you use Chargebee’s AvaTax for Communications 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.entity_code or exempt_number attributes if you use Chargebee’s AvaTax for Sales or specify exemption_details attribute if you use Chargebee’s AvaTax for Communications 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.entity_code or exempt_number attributes if you use Chargebee’s AvaTax for Sales or specify exemption_details attribute if you use Chargebee’s AvaTax for Communications 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.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.
Resource object representing export
" } }, "required" : [ "export" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/exports/transactions" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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 oftype = refund. This value is set by Chargebee when an automated chargeback occurs. You can also set this explicitly when recording a 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 ",
"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" ],
"example" : null
},
"is_not" : {
"type" : "string",
"description" : "* `card` - Card\n* `cash` - Cash\n* `check` - Check\n* `chargeback` - Only applicable for a transaction of type = refund. This value is set by Chargebee when an automated chargeback occurs. You can also set this explicitly when recording a 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 ",
"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" ],
"example" : null
},
"in" : {
"type" : "string",
"description" : "* `card` - Card\n* `cash` - Cash\n* `check` - Check\n* `chargeback` - Only applicable for a transaction of type = refund. This value is set by Chargebee when an automated chargeback occurs. You can also set this explicitly when recording a 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 ",
"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" ],
"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)(,(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))*\\]$",
"example" : null
},
"not_in" : {
"type" : "string",
"description" : "* `card` - Card\n* `cash` - Cash\n* `check` - Check\n* `chargeback` - Only applicable for a transaction of type = refund. This value is set by Chargebee when an automated chargeback occurs. You can also set this explicitly when recording a 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 ",
"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" ],
"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)(,(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))*\\]$",
"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` - Ezidebit is a payment gateway integration based in Australia that supports automated direct debit, BPAY, and card payments for businesses.payment_source_type. \n* `deutsche_bank` - Deutsche Bank is the leading German bank with strong European roots and a global network. \n* `ezidebit` - Ezidebit is a payment gateway integration based in Australia that supports automated direct debit, BPAY, and card payments for businesses.payment_source_type. \n* `deutsche_bank` - Deutsche Bank is the leading German bank with strong European roots and a global network. \n* `ezidebit` - Ezidebit is a payment gateway integration based in Australia that supports automated direct debit, BPAY, and card payments for businesses.payment_source_type. \n* `deutsche_bank` - Deutsche Bank is the leading German bank with strong European roots and a global network. \n* `ezidebit` - Ezidebit is a payment gateway integration based in Australia that supports automated direct debit, BPAY, and card payments for businesses.The reference number for this transaction. For example, the check number when payment_method\n= check\n.
amount from the customer’s payment_source.\n* `payment` - The transaction represents capture of amount from the customer’s payment_source.\n* `refund` - The transaction represents a refund of amount to the customer’s payment_source.\n* `payment_reversal` - Indicates a reversal transaction.",
"enum" : [ "authorization", "payment", "refund", "payment_reversal" ],
"example" : null
},
"is_not" : {
"type" : "string",
"description" : "* `authorization` - The transaction represents an authorization for capturing the amount from the customer’s payment_source.\n* `payment` - The transaction represents capture of amount from the customer’s payment_source.\n* `refund` - The transaction represents a refund of amount to the customer’s payment_source.\n* `payment_reversal` - Indicates a reversal transaction.",
"enum" : [ "authorization", "payment", "refund", "payment_reversal" ],
"example" : null
},
"in" : {
"type" : "string",
"description" : "* `authorization` - The transaction represents an authorization for capturing the amount from the customer’s payment_source.\n* `payment` - The transaction represents capture of amount from the customer’s payment_source.\n* `refund` - The transaction represents a refund of amount to the customer’s payment_source.\n* `payment_reversal` - Indicates a reversal transaction.",
"enum" : [ "authorization", "payment", "refund", "payment_reversal" ],
"pattern" : "^\\[(authorization|payment|refund|payment_reversal)(,(authorization|payment|refund|payment_reversal))*\\]$",
"example" : null
},
"not_in" : {
"type" : "string",
"description" : "* `authorization` - The transaction represents an authorization for capturing the amount from the customer’s payment_source.\n* `payment` - The transaction represents capture of amount from the customer’s payment_source.\n* `refund` - The transaction represents a refund of amount to the customer’s payment_source.\n* `payment_reversal` - Indicates a reversal transaction.",
"enum" : [ "authorization", "payment", "refund", "payment_reversal" ],
"pattern" : "^\\[(authorization|payment|refund|payment_reversal)(,(authorization|payment|refund|payment_reversal))*\\]$",
"example" : null
}
}
},
"date" : {
"type" : "object",
"deprecated" : false,
"description" : "Indicates when this transaction occurred.\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. \\* \\`success\\` - The transaction is successful. \\* \\`voided\\` - The transaction got voided or authorization expired at gateway. \\* \\`failure\\` - Transaction failed. Refer the 'error_code' and 'error_text' fields to know the reason for failure \\* \\`timeout\\` - Transaction failed because of Gateway not accepting the connection. \\* \\`needs_attention\\` - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually \\* \\`late_failure\\` - This status indicates that late failure has been recorded for the transaction that has encountered success state in the previous stage.\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. \\* \\`success\\` - The transaction is successful. \\* \\`voided\\` - The transaction got voided or authorization expired at gateway. \\* \\`failure\\` - Transaction failed. Refer the 'error_code' and 'error_text' fields to know the reason for failure \\* \\`timeout\\` - Transaction failed because of Gateway not accepting the connection. \\* \\`needs_attention\\` - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually \\* \\`late_failure\\` - This status indicates that late failure has been recorded for the transaction that has encountered success state in the previous stage.\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. \\* \\`success\\` - The transaction is successful. \\* \\`voided\\` - The transaction got voided or authorization expired at gateway. \\* \\`failure\\` - Transaction failed. Refer the 'error_code' and 'error_text' fields to know the reason for failure \\* \\`timeout\\` - Transaction failed because of Gateway not accepting the connection. \\* \\`needs_attention\\` - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually \\* \\`late_failure\\` - This status indicates that late failure has been recorded for the transaction that has encountered success state in the previous stage.\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. \\* \\`success\\` - The transaction is successful. \\* \\`voided\\` - The transaction got voided or authorization expired at gateway. \\* \\`failure\\` - Transaction failed. Refer the 'error_code' and 'error_text' fields to know the reason for failure \\* \\`timeout\\` - Transaction failed because of Gateway not accepting the connection. \\* \\`needs_attention\\` - Connection with Gateway got terminated abruptly. So, status of this transaction needs to be resolved manually \\* \\`late_failure\\` - This status indicates that late failure has been recorded for the transaction that has encountered success state in the previous stage.\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.
Resource object representing export
" } }, "required" : [ "export" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/exports/invoices" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "payment_owner" : { "type" : "object", "deprecated" : false, "description" : "optional, string filter Payment owner of an invoice. \\*\\*Supported operators :\\*\\* is, is_not, starts_with, in, not_in \\*\\*Example →\\*\\* \\*payment_owner\\\\\\[is\\\\\\] = \"payment_customer\"\\*\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. NOTE: Not to be used if \\*consolidated invoicing\\* is 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` -status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.status when Metered Billing is enabled for the site.status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.status when Metered Billing is enabled for the site.status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.status when Metered Billing is enabled for the site.status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.status when Metered Billing is enabled for the site.Payments collected successfully for the invoice. This is the sum of linked_payments[].txn_amount\nfor all linked_payments[]\nthat have txn_status\nas success.
The unpaid amount that is due on the invoice. This is calculated as: total
amount_paid\napplied_credits.applied_amountadjustment_credit_notes.cn_totallinked_taxes_withheld.amount.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 about the best practice before performing full export.
Resource object representing export
" } }, "required" : [ "export" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/exports/{export-id}" : { "get" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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
" } }, "required" : [ "export" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/exports/deferred_revenue" : { "post" : { "summary" : "Export deferred revenue reports", "description" : "**Important:**\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\\* subscription -\n\nSubscription\n\\* invoice -\n\nInvoice\n\\* product -\n\nProduct (Includes Plan, Addon and Adhoc)\n\\* customer -\n\nCustomer\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 Payment owner of an invoice. \\*\\*Supported operators :\\*\\* is, is_not, starts_with, in, not_in \\*\\*Example →\\*\\* \\*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 Reason code for canceling the subscription. Must be one from a list of reason codes set in the Chargebee app in \\*\\*Settings \\\\\\> Configure Chargebee \\\\\\> Reason Codes \\\\\\> Subscriptions \\\\\\> Subscription Cancellation\\*\\* . Must be passed if set as mandatory in the app. The codes are case-sensitive. \\*\\*Supported operators :\\*\\* is, is_not, starts_with, in, not_in \\*\\*Example →\\*\\* \\*cancel_reason_code\\\\\\[is_not\\\\\\] = \"Not Paid\"\\*\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 The ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity. \\*\\*Note\\*\\* \\[Multiple Business Entities\\](/docs/api/getting-started) is a feature available only on Product Catalog 2.0. \\*\\*Supported operators :\\*\\* is, is_not, starts_with \\*\\*Example →\\*\\* \\*business_entity_id\\\\\\[is\\\\\\] = \"business_entity_id\"\\*\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` -status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.status when Metered Billing is enabled for the site.status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.status when Metered Billing is enabled for the site.status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.status when Metered Billing is enabled for the site.status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.status when Metered Billing is enabled for the site.Payments collected successfully for the invoice. This is the sum of linked_payments[].txn_amount\nfor all linked_payments[]\nthat have txn_status\nas success.
The unpaid amount that is due on the invoice. This is calculated as: total
amount_paid\napplied_credits.applied_amountadjustment_credit_notes.cn_totallinked_taxes_withheld.amount.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.
Time at which the subscription status\nlast changed to\nactive.\nFor example, this value is updated when an in_trial\nor\ncancelled\nsubscription activates.
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.
If true\n, there are subscription changes scheduled on next renewal.
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.
Set to false\nto override for this subscription, the site-level setting\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\n.
entity_code or exempt_number attributes if you use Chargebee’s AvaTax for Sales or specify exemption_details attribute if you use Chargebee’s AvaTax for Communications 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.entity_code or exempt_number attributes if you use Chargebee’s AvaTax for Sales or specify exemption_details attribute if you use Chargebee’s AvaTax for Communications 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.entity_code or exempt_number attributes if you use Chargebee’s AvaTax for Sales or specify exemption_details attribute if you use Chargebee’s AvaTax for Communications 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.entity_code or exempt_number attributes if you use Chargebee’s AvaTax for Sales or specify exemption_details attribute if you use Chargebee’s AvaTax for Communications 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.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.
Resource object representing export
" } }, "required" : [ "export" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/exports/revenue_recognition" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\\* subscription -\n\nSubscription\n\\* invoice -\n\nInvoice\n\\* product -\n\nProduct (Includes Plan, Addon and Adhoc)\n\\* customer -\n\nCustomer\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 Payment owner of an invoice. \\*\\*Supported operators :\\*\\* is, is_not, starts_with, in, not_in \\*\\*Example →\\*\\* \\*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 Reason code for canceling the subscription. Must be one from a list of reason codes set in the Chargebee app in \\*\\*Settings \\\\\\> Configure Chargebee \\\\\\> Reason Codes \\\\\\> Subscriptions \\\\\\> Subscription Cancellation\\*\\* . Must be passed if set as mandatory in the app. The codes are case-sensitive. \\*\\*Supported operators :\\*\\* is, is_not, starts_with, in, not_in \\*\\*Example →\\*\\* \\*cancel_reason_code\\\\\\[is_not\\\\\\] = \"Not Paid\"\\*\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 The ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity. \\*\\*Note\\*\\* \\[Multiple Business Entities\\](/docs/api/getting-started) is a feature available only on Product Catalog 2.0. \\*\\*Supported operators :\\*\\* is, is_not, starts_with \\*\\*Example →\\*\\* \\*business_entity_id\\\\\\[is\\\\\\] = \"business_entity_id\"\\*\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` -status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.status when Metered Billing is enabled for the site.status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.status when Metered Billing is enabled for the site.status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.status when Metered Billing is enabled for the site.status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.status when Metered Billing is enabled for the site.Payments collected successfully for the invoice. This is the sum of linked_payments[].txn_amount\nfor all linked_payments[]\nthat have txn_status\nas success.
The unpaid amount that is due on the invoice. This is calculated as: total
amount_paid\napplied_credits.applied_amountadjustment_credit_notes.cn_totallinked_taxes_withheld.amount.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.
Time at which the subscription status\nlast changed to\nactive.\nFor example, this value is updated when an in_trial\nor\ncancelled\nsubscription activates.
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.
If true\n, there are subscription changes scheduled on next renewal.
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.
Set to false\nto override for this subscription, the site-level setting\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\n.
entity_code or exempt_number attributes if you use Chargebee’s AvaTax for Sales or specify exemption_details attribute if you use Chargebee’s AvaTax for Communications 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.entity_code or exempt_number attributes if you use Chargebee’s AvaTax for Sales or specify exemption_details attribute if you use Chargebee’s AvaTax for Communications 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.entity_code or exempt_number attributes if you use Chargebee’s AvaTax for Sales or specify exemption_details attribute if you use Chargebee’s AvaTax for Communications 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.entity_code or exempt_number attributes if you use Chargebee’s AvaTax for Sales or specify exemption_details attribute if you use Chargebee’s AvaTax for Communications 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.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.
Resource object representing export
" } }, "required" : [ "export" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/exports/credit_notes" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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. NOTE: Not to be used if \\*consolidated invoicing\\* feature 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) about credit note types.\n", "example" : "adjustment", "properties" : { "is" : { "type" : "string", "description" : "\\* \\`adjustment\\` - Adjustment Credit Note \\* \\`refundable\\` - Refundable Credit Note \\* \\`store\\` - Store Credit Note\n", "enum" : [ "adjustment", "refundable", "store" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`adjustment\\` - Adjustment Credit Note \\* \\`refundable\\` - Refundable Credit Note \\* \\`store\\` - Store Credit Note\n", "enum" : [ "adjustment", "refundable", "store" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`adjustment\\` - Adjustment Credit Note \\* \\`refundable\\` - Refundable Credit Note \\* \\`store\\` - Store Credit Note\n", "enum" : [ "adjustment", "refundable", "store" ], "pattern" : "^\\[(adjustment|refundable|store)(,(adjustment|refundable|store))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`adjustment\\` - Adjustment Credit Note \\* \\`refundable\\` - Refundable Credit Note \\* \\`store\\` - Store Credit Note\n", "enum" : [ "adjustment", "refundable", "store" ], "pattern" : "^\\[(adjustment|refundable|store)(,(adjustment|refundable|store))*\\]$", "example" : null } } }, "reason_code" : { "type" : "object", "deprecated" : false, "description" : "The reason for issuing this Credit Note. The following reason codes are supported now\\\\\\[Deprecated; use the \\[create_reason_code\\](/docs/api/credit_notes/credit_note-object#create_reason_code) parameter instead\\\\\\]\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. \\* \\`subscription_change\\` - This reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html) is enabled \\* \\`subscription_cancellation\\` - This reason will be set automatically for Credit Notes created during cancel subscription operation \\* \\`subscription_pause\\` - This reason will be automatically set to credit notes created during pause/resume subscription operation. \\* \\`chargeback\\` - Can be set when you are recording your customer Chargebacks \\* \\`product_unsatisfactory\\` - Product Unsatisfactory \\* \\`service_unsatisfactory\\` - Service Unsatisfactory \\* \\`order_change\\` - Order Change \\* \\`order_cancellation\\` - Order Cancellation \\* \\`waiver\\` - Waiver \\* \\`other\\` - Can be set when none of the above reason codes are applicable \\* \\`fraudulent\\` - FRAUDULENT\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. \\* \\`subscription_change\\` - This reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html) is enabled \\* \\`subscription_cancellation\\` - This reason will be set automatically for Credit Notes created during cancel subscription operation \\* \\`subscription_pause\\` - This reason will be automatically set to credit notes created during pause/resume subscription operation. \\* \\`chargeback\\` - Can be set when you are recording your customer Chargebacks \\* \\`product_unsatisfactory\\` - Product Unsatisfactory \\* \\`service_unsatisfactory\\` - Service Unsatisfactory \\* \\`order_change\\` - Order Change \\* \\`order_cancellation\\` - Order Cancellation \\* \\`waiver\\` - Waiver \\* \\`other\\` - Can be set when none of the above reason codes are applicable \\* \\`fraudulent\\` - FRAUDULENT\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. \\* \\`subscription_change\\` - This reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html) is enabled \\* \\`subscription_cancellation\\` - This reason will be set automatically for Credit Notes created during cancel subscription operation \\* \\`subscription_pause\\` - This reason will be automatically set to credit notes created during pause/resume subscription operation. \\* \\`chargeback\\` - Can be set when you are recording your customer Chargebacks \\* \\`product_unsatisfactory\\` - Product Unsatisfactory \\* \\`service_unsatisfactory\\` - Service Unsatisfactory \\* \\`order_change\\` - Order Change \\* \\`order_cancellation\\` - Order Cancellation \\* \\`waiver\\` - Waiver \\* \\`other\\` - Can be set when none of the above reason codes are applicable \\* \\`fraudulent\\` - FRAUDULENT\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. \\* \\`subscription_change\\` - This reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html) is enabled \\* \\`subscription_cancellation\\` - This reason will be set automatically for Credit Notes created during cancel subscription operation \\* \\`subscription_pause\\` - This reason will be automatically set to credit notes created during pause/resume subscription operation. \\* \\`chargeback\\` - Can be set when you are recording your customer Chargebacks \\* \\`product_unsatisfactory\\` - Product Unsatisfactory \\* \\`service_unsatisfactory\\` - Service Unsatisfactory \\* \\`order_change\\` - Order Change \\* \\`order_cancellation\\` - Order Cancellation \\* \\`waiver\\` - Waiver \\* \\`other\\` - Can be set when none of the above reason codes are applicable \\* \\`fraudulent\\` - FRAUDULENT\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\\*\\*. Must 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. \\* \\`refunded\\` - When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded). \\* \\`refund_due\\` - When the credits are yet to be used, or have been partially used. \\* \\`voided\\` - When the Credit Note has been cancelled.\n", "enum" : [ "adjusted", "refunded", "refund_due", "voided" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`adjusted\\` - When the Credit Note has been adjusted against an invoice. \\* \\`refunded\\` - When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded). \\* \\`refund_due\\` - When the credits are yet to be used, or have been partially used. \\* \\`voided\\` - When the Credit Note has been cancelled.\n", "enum" : [ "adjusted", "refunded", "refund_due", "voided" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`adjusted\\` - When the Credit Note has been adjusted against an invoice. \\* \\`refunded\\` - When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded). \\* \\`refund_due\\` - When the credits are yet to be used, or have been partially used. \\* \\`voided\\` - When the Credit Note has been cancelled.\n", "enum" : [ "adjusted", "refunded", "refund_due", "voided" ], "pattern" : "^\\[(adjusted|refunded|refund_due|voided)(,(adjusted|refunded|refund_due|voided))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`adjusted\\` - When the Credit Note has been adjusted against an invoice. \\* \\`refunded\\` - When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded). \\* \\`refund_due\\` - When the credits are yet to be used, or have been partially used. \\* \\`voided\\` - When the Credit Note has been cancelled.\n", "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. \\* \\`tax_inclusive\\` - All amounts in the document are inclusive of tax.\n", "enum" : [ "tax_exclusive", "tax_inclusive" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`tax_exclusive\\` - All amounts in the document are exclusive of tax. \\* \\`tax_inclusive\\` - All amounts in the document are inclusive of tax.\n", "enum" : [ "tax_exclusive", "tax_inclusive" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`tax_exclusive\\` - All amounts in the document are exclusive of tax. \\* \\`tax_inclusive\\` - All amounts in the document are inclusive of tax.\n", "enum" : [ "tax_exclusive", "tax_inclusive" ], "pattern" : "^\\[(tax_exclusive|tax_inclusive)(,(tax_exclusive|tax_inclusive))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`tax_exclusive\\` - All amounts in the document are exclusive of tax. \\* \\`tax_inclusive\\` - All amounts in the document are inclusive of tax.\n", "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. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "pattern" : "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "pattern" : "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\]$", "example" : null } } } }, "example" : null } }, "example" : null }, "encoding" : { "credit_note" : { "style" : "deepObject", "explode" : true } } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "export" : { "$ref" : "#/components/schemas/Export", "description" : "Resource object representing export
" } }, "required" : [ "export" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/exports/coupons" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "currency_code" : { "type" : "object", "deprecated" : false, "description" : "optional, string filter The currency code (\\[ISO 4217 format\\](https://www.chargebee.com/docs/supported-currencies.html) ) of the coupon. Applicable for \\*fixed_amount\\* coupons alone. \\*\\*Supported operators :\\*\\* is, is_not, starts_with, in, not_in \\*\\*Example →\\*\\* \\*currency_code\\\\\\[is\\\\\\] = \"USD\"\\*\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" : { "in" : { "type" : "string", "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, "is" : { "type" : "string", "minLength" : 1, "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.
\nNote:
When the coupon ID contains a special character; for example: #, the API returns an error. Make sure that you encode the coupon ID in the path parameter before making an API call.
The display name used in web interface for identifying the coupon.
\nNote:
When the name of the coupon set contains a special character; for example: #, the API returns an error. Make sure that you encode the name of the coupon set in the path parameter before making an API call.
period and period_unit. ",
"enum" : [ "one_time", "forever", "limited_period" ],
"example" : null
},
"is_not" : {
"type" : "string",
"description" : "* `one_time` - The coupon stays attached to the subscription till it is applied on an invoice once. It is removed after that from the subscription.\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. ",
"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. ",
"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. ",
"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 or 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.",
"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 or 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.",
"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 or 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.",
"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 or 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.",
"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` - invoice.line_item.amount that corresponds to the item price specified by item_price_id.\ninvoice.line_item.amount that corresponds to the plan or addon specified by plan_ids and addon_ids.\nsub_total.\n* `specified_items_total` - **(Deprecated)** Discount will be applied to the total of plan and addon items specified.\n* `each_specified_item` - invoice.line_item.amount that corresponds to the item price specified by item_price_id.\ninvoice.line_item.amount that corresponds to the plan or addon specified by plan_ids and addon_ids.\nsub_total.\n* `specified_items_total` - **(Deprecated)** Discount will be applied to the total of plan and addon items specified.\n* `each_specified_item` - invoice.line_item.amount that corresponds to the item price specified by item_price_id.\ninvoice.line_item.amount that corresponds to the plan or addon specified by plan_ids and addon_ids.\nsub_total.\n* `specified_items_total` - **(Deprecated)** Discount will be applied to the total of plan and addon items specified.\n* `each_specified_item` - invoice.line_item.amount that corresponds to the item price specified by item_price_id.\ninvoice.line_item.amount that corresponds to the plan or addon specified by plan_ids and addon_ids.\nResource object representing export
" } }, "required" : [ "export" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/exports/orders" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "total" : { "type" : "object", "deprecated" : false, "description" : "optional, in cents filter Total amount charged for the order. \\*\\*Supported operators :\\*\\* is, is_not, lt, lte, gt, gte, between \\*\\*Example →\\*\\* \\*total\\\\\\[gt\\\\\\] = \"1394532759\"\\*\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. \\* \\`processing\\` - Order is being processed. Applicable only if you are using Chargebee's legacy order management system \\* \\`complete\\` - Order has been processed successfully. Applicable only if you are using Chargebee's legacy order management system \\* \\`cancelled\\` - Order has been cancelled. Applicable only if you are using Chargebee's legacy order management system \\* \\`voided\\` - Order has been voided. Applicable only if you are using Chargebee's legacy order management system \\* \\`queued\\` - Order is yet to be processed by any system, these are scheduled orders created by Chargebee \\* \\`awaiting_shipment\\` - The order has been picked up by an integration system, and synced to a shipping management platform \\* \\`on_hold\\` - The order is paused from being processed. \\* \\`delivered\\` - The order has been delivered to the customer. \\* \\`shipped\\` - The order has moved from order management system to a shipping system. \\* \\`partially_delivered\\` - The order has been partially delivered to the customer. \\* \\`returned\\` - The order has been returned after delivery.\n", "enum" : [ "new", "processing", "complete", "cancelled", "voided", "queued", "awaiting_shipment", "on_hold", "delivered", "shipped", "partially_delivered", "returned" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`new\\` - Order has been created. Applicable only if you are using Chargebee's legacy order management system. \\* \\`processing\\` - Order is being processed. Applicable only if you are using Chargebee's legacy order management system \\* \\`complete\\` - Order has been processed successfully. Applicable only if you are using Chargebee's legacy order management system \\* \\`cancelled\\` - Order has been cancelled. Applicable only if you are using Chargebee's legacy order management system \\* \\`voided\\` - Order has been voided. Applicable only if you are using Chargebee's legacy order management system \\* \\`queued\\` - Order is yet to be processed by any system, these are scheduled orders created by Chargebee \\* \\`awaiting_shipment\\` - The order has been picked up by an integration system, and synced to a shipping management platform \\* \\`on_hold\\` - The order is paused from being processed. \\* \\`delivered\\` - The order has been delivered to the customer. \\* \\`shipped\\` - The order has moved from order management system to a shipping system. \\* \\`partially_delivered\\` - The order has been partially delivered to the customer. \\* \\`returned\\` - The order has been returned after delivery.\n", "enum" : [ "new", "processing", "complete", "cancelled", "voided", "queued", "awaiting_shipment", "on_hold", "delivered", "shipped", "partially_delivered", "returned" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`new\\` - Order has been created. Applicable only if you are using Chargebee's legacy order management system. \\* \\`processing\\` - Order is being processed. Applicable only if you are using Chargebee's legacy order management system \\* \\`complete\\` - Order has been processed successfully. Applicable only if you are using Chargebee's legacy order management system \\* \\`cancelled\\` - Order has been cancelled. Applicable only if you are using Chargebee's legacy order management system \\* \\`voided\\` - Order has been voided. Applicable only if you are using Chargebee's legacy order management system \\* \\`queued\\` - Order is yet to be processed by any system, these are scheduled orders created by Chargebee \\* \\`awaiting_shipment\\` - The order has been picked up by an integration system, and synced to a shipping management platform \\* \\`on_hold\\` - The order is paused from being processed. \\* \\`delivered\\` - The order has been delivered to the customer. \\* \\`shipped\\` - The order has moved from order management system to a shipping system. \\* \\`partially_delivered\\` - The order has been partially delivered to the customer. \\* \\`returned\\` - The order has been returned after delivery.\n", "enum" : [ "new", "processing", "complete", "cancelled", "voided", "queued", "awaiting_shipment", "on_hold", "delivered", "shipped", "partially_delivered", "returned" ], "pattern" : "^\\[(new|processing|complete|cancelled|voided|queued|awaiting_shipment|on_hold|delivered|shipped|partially_delivered|returned)(,(new|processing|complete|cancelled|voided|queued|awaiting_shipment|on_hold|delivered|shipped|partially_delivered|returned))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`new\\` - Order has been created. Applicable only if you are using Chargebee's legacy order management system. \\* \\`processing\\` - Order is being processed. Applicable only if you are using Chargebee's legacy order management system \\* \\`complete\\` - Order has been processed successfully. Applicable only if you are using Chargebee's legacy order management system \\* \\`cancelled\\` - Order has been cancelled. Applicable only if you are using Chargebee's legacy order management system \\* \\`voided\\` - Order has been voided. Applicable only if you are using Chargebee's legacy order management system \\* \\`queued\\` - Order is yet to be processed by any system, these are scheduled orders created by Chargebee \\* \\`awaiting_shipment\\` - The order has been picked up by an integration system, and synced to a shipping management platform \\* \\`on_hold\\` - The order is paused from being processed. \\* \\`delivered\\` - The order has been delivered to the customer. \\* \\`shipped\\` - The order has moved from order management system to a shipping system. \\* \\`partially_delivered\\` - The order has been partially delivered to the customer. \\* \\`returned\\` - The order has been returned after delivery.\n", "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. \\* \\`tax_inclusive\\` - All amounts in the document are inclusive of tax.\n", "enum" : [ "tax_exclusive", "tax_inclusive" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`tax_exclusive\\` - All amounts in the document are exclusive of tax. \\* \\`tax_inclusive\\` - All amounts in the document are inclusive of tax.\n", "enum" : [ "tax_exclusive", "tax_inclusive" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`tax_exclusive\\` - All amounts in the document are exclusive of tax. \\* \\`tax_inclusive\\` - All amounts in the document are inclusive of tax.\n", "enum" : [ "tax_exclusive", "tax_inclusive" ], "pattern" : "^\\[(tax_exclusive|tax_inclusive)(,(tax_exclusive|tax_inclusive))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`tax_exclusive\\` - All amounts in the document are exclusive of tax. \\* \\`tax_inclusive\\` - All amounts in the document are inclusive of tax.\n", "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 \\* \\`partially_resent\\` - Order is Partially resent\n", "enum" : [ "fully_resent", "partially_resent" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`fully_resent\\` - Order is Fully resent \\* \\`partially_resent\\` - Order is Partially resent\n", "enum" : [ "fully_resent", "partially_resent" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`fully_resent\\` - Order is Fully resent \\* \\`partially_resent\\` - Order is Partially resent\n", "enum" : [ "fully_resent", "partially_resent" ], "pattern" : "^\\[(fully_resent|partially_resent)(,(fully_resent|partially_resent))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`fully_resent\\` - Order is Fully resent \\* \\`partially_resent\\` - Order is Partially resent\n", "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
" } }, "required" : [ "export" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/exports/addons" : { "post" : { "summary" : "Export addons", "description" : "This API triggers export of addon data. The exported zip file contains CSV files with addon-related data.\n", "operationId" : "export_addons", "parameters" : [ { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "currency_code" : { "type" : "object", "deprecated" : false, "description" : "optional, string filter The currency code (ISO 4217 format) of the addon. \\*\\*Supported operators :\\*\\* is, is_not, starts_with, in, not_in \\*\\*Example →\\*\\* \\*currency_code\\\\\\[is\\\\\\] = \"USD\"\\*\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. \\* \\`non_recurring\\` - Charged immediately and only once every time it is applied.\n", "enum" : [ "recurring", "non_recurring" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`recurring\\` - Charges are automatically applied in sync with the billing frequency of subscription. \\* \\`non_recurring\\` - Charged immediately and only once every time it is applied.\n", "enum" : [ "recurring", "non_recurring" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`recurring\\` - Charges are automatically applied in sync with the billing frequency of subscription. \\* \\`non_recurring\\` - Charged immediately and only once every time it is applied.\n", "enum" : [ "recurring", "non_recurring" ], "pattern" : "^\\[(recurring|non_recurring)(,(recurring|non_recurring))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`recurring\\` - Charges are automatically applied in sync with the billing frequency of subscription. \\* \\`non_recurring\\` - Charged immediately and only once every time it is applied.\n", "enum" : [ "recurring", "non_recurring" ], "pattern" : "^\\[(recurring|non_recurring)(,(recurring|non_recurring))*\\]$", "example" : null } } }, "price" : { "type" : "object", "deprecated" : false, "description" : "Addon price is calculated based on the addon type and charge type. \\[Learn more\\](https://www.chargebee.com/docs/addons.html#charge-type-and-pricing). The unit depends on the \\[type of currency\\](/docs/api/getting-started) .\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) \\* \\`week\\` - Charge based on week(s) \\* \\`month\\` - Charge based on month(s) \\* \\`year\\` - Charge based on year(s) \\* \\`not_applicable\\` - not applicable for this addon\n", "enum" : [ "day", "week", "month", "year", "not_applicable" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`day\\` - Charge based on Day(S) \\* \\`week\\` - Charge based on week(s) \\* \\`month\\` - Charge based on month(s) \\* \\`year\\` - Charge based on year(s) \\* \\`not_applicable\\` - not applicable for this addon\n", "enum" : [ "day", "week", "month", "year", "not_applicable" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`day\\` - Charge based on Day(S) \\* \\`week\\` - Charge based on week(s) \\* \\`month\\` - Charge based on month(s) \\* \\`year\\` - Charge based on year(s) \\* \\`not_applicable\\` - not applicable for this addon\n", "enum" : [ "day", "week", "month", "year", "not_applicable" ], "pattern" : "^\\[(day|week|month|year|not_applicable)(,(day|week|month|year|not_applicable))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`day\\` - Charge based on Day(S) \\* \\`week\\` - Charge based on week(s) \\* \\`month\\` - Charge based on month(s) \\* \\`year\\` - Charge based on year(s) \\* \\`not_applicable\\` - not applicable for this addon\n", "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 \\* \\`archived\\` - No new associations with subscriptions are allowed. Existing associations for recurring addons remain as-is and can be removed if required. \\* \\`deleted\\` - Indicates the addon has been deleted.\n", "enum" : [ "active", "archived", "deleted" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`active\\` - Only active addons can be applied to subscriptions \\* \\`archived\\` - No new associations with subscriptions are allowed. Existing associations for recurring addons remain as-is and can be removed if required. \\* \\`deleted\\` - Indicates the addon has been deleted.\n", "enum" : [ "active", "archived", "deleted" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`active\\` - Only active addons can be applied to subscriptions \\* \\`archived\\` - No new associations with subscriptions are allowed. Existing associations for recurring addons remain as-is and can be removed if required. \\* \\`deleted\\` - Indicates the addon has been deleted.\n", "enum" : [ "active", "archived", "deleted" ], "pattern" : "^\\[(active|archived|deleted)(,(active|archived|deleted))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`active\\` - Only active addons can be applied to subscriptions \\* \\`archived\\` - No new associations with subscriptions are allowed. Existing associations for recurring addons remain as-is and can be removed if required. \\* \\`deleted\\` - Indicates the addon has been deleted.\n", "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. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "pattern" : "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "pattern" : "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\]$", "example" : null } } } }, "example" : null } }, "example" : null }, "encoding" : { "addon" : { "style" : "deepObject", "explode" : true } } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "export" : { "$ref" : "#/components/schemas/Export", "description" : "Resource object representing export
" } }, "required" : [ "export" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/exports/subscriptions" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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* data -Provides the full set of data for the subscriptions in multiple .csv files.
Provides a .csv file whose columns match the subscription schema. This file format can be readily imported through the UI by using Bulk Operations.
Time at which the subscription status\nlast changed to\nactive.\nFor example, this value is updated when an in_trial\nor\ncancelled\nsubscription activates.
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.
If true\n, there are subscription changes scheduled on next renewal.
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.
Set to false\nto override for this subscription, the site-level setting\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\n.
Resource object representing export
" } }, "required" : [ "export" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/exports/plans" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "currency_code" : { "type" : "object", "deprecated" : false, "description" : "optional, string filter The currency code (ISO 4217 format) of the plan. \\*\\*Supported operators :\\*\\* is, is_not, starts_with, in, not_in \\*\\*Example →\\*\\* \\*currency_code\\\\\\[is\\\\\\] = \"USD\"\\*\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", "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) \\* \\`week\\` - Charge based on week(s) \\* \\`month\\` - Charge based on month(s) \\* \\`year\\` - Charge based on year(s)\n", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`day\\` - Charge based on day(s) \\* \\`week\\` - Charge based on week(s) \\* \\`month\\` - Charge based on month(s) \\* \\`year\\` - Charge based on year(s)\n", "enum" : [ "day", "week", "month", "year" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`day\\` - Charge based on day(s) \\* \\`week\\` - Charge based on week(s) \\* \\`month\\` - Charge based on month(s) \\* \\`year\\` - Charge based on year(s)\n", "enum" : [ "day", "week", "month", "year" ], "pattern" : "^\\[(day|week|month|year)(,(day|week|month|year))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`day\\` - Charge based on day(s) \\* \\`week\\` - Charge based on week(s) \\* \\`month\\` - Charge based on month(s) \\* \\`year\\` - Charge based on year(s)\n", "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 \\* \\`month\\` - In months\n", "enum" : [ "day", "month" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`day\\` - In days \\* \\`month\\` - In months\n", "enum" : [ "day", "month" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`day\\` - In days \\* \\`month\\` - In months\n", "enum" : [ "day", "month" ], "pattern" : "^\\[(day|month)(,(day|month))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`day\\` - In days \\* \\`month\\` - In months\n", "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. \\* \\`restricted\\` - Only addons marked as 'applicable_addons' are applicable with the plan.\n", "enum" : [ "all", "restricted" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`all\\` - All addons are applicable with this plan. \\* \\`restricted\\` - Only addons marked as 'applicable_addons' are applicable with the plan.\n", "enum" : [ "all", "restricted" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`all\\` - All addons are applicable with this plan. \\* \\`restricted\\` - Only addons marked as 'applicable_addons' are applicable with the plan.\n", "enum" : [ "all", "restricted" ], "pattern" : "^\\[(all|restricted)(,(all|restricted))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`all\\` - All addons are applicable with this plan. \\* \\`restricted\\` - Only addons marked as 'applicable_addons' are applicable with the plan.\n", "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. \\* \\`archived\\` - No new subscriptions allowed for the plan. Existing subscriptions on this plan will remain as-is and can be migrated to another active plan if required. \\* \\`deleted\\` - Indicates the plan has been deleted.\n", "enum" : [ "active", "archived", "deleted" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`active\\` - New subscriptions can be created with the plan. \\* \\`archived\\` - No new subscriptions allowed for the plan. Existing subscriptions on this plan will remain as-is and can be migrated to another active plan if required. \\* \\`deleted\\` - Indicates the plan has been deleted.\n", "enum" : [ "active", "archived", "deleted" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`active\\` - New subscriptions can be created with the plan. \\* \\`archived\\` - No new subscriptions allowed for the plan. Existing subscriptions on this plan will remain as-is and can be migrated to another active plan if required. \\* \\`deleted\\` - Indicates the plan has been deleted.\n", "enum" : [ "active", "archived", "deleted" ], "pattern" : "^\\[(active|archived|deleted)(,(active|archived|deleted))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`active\\` - New subscriptions can be created with the plan. \\* \\`archived\\` - No new subscriptions allowed for the plan. Existing subscriptions on this plan will remain as-is and can be migrated to another active plan if required. \\* \\`deleted\\` - Indicates the plan has been deleted.\n", "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. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "example" : null }, "is_not" : { "type" : "string", "description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "example" : null }, "in" : { "type" : "string", "description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "pattern" : "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\]$", "example" : null }, "not_in" : { "type" : "string", "description" : "\\* \\`web\\` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \\* \\`app_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \\* \\`play_store\\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \nIn-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information.\n", "enum" : [ "web", "app_store", "play_store" ], "pattern" : "^\\[(web|app_store|play_store)(,(web|app_store|play_store))*\\]$", "example" : null } } } }, "example" : null } }, "example" : null }, "encoding" : { "plan" : { "style" : "deepObject", "explode" : true } } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "export" : { "$ref" : "#/components/schemas/Export", "description" : "Resource object representing export
" } }, "required" : [ "export" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/full_exports/status" : { "get" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-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
" } }, "required" : [ "full_export" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/payment_intents/{payment-intent-id}" : { "get" : { "summary" : "Retrieve a payment intent", "description" : "Retrieves the PaymentIntent resource.\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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
" } }, "required" : [ "payment_intent" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] }, "post" : { "summary" : "Update a payment intent", "description" : "Updating properties on a PaymentIntent object. All the subsequent 3DS transaction attempts will have the updated values.\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\\* google_pay -\n\ngoogle_pay\n\\* pay_co -\n\nPayments made via PayCo\n\\* alipay_hk - \\* apple_pay -\n\napple_pay\n\\* cash_app_pay -\n\nPayments made via Cash App Pay.\n\\* ideal -\n\nideal\n\\* bancontact -\n\nbancontact\n\\* netbanking_emandates -\n\nnetbanking_emandates\n\\* pay_to -\n\nPayTo\n\\* trustly -\n\nTrustly\n\\* venmo -\n\nVenmo\n\\* after_pay -\n\nPayments made via Afterpay\n\\* alipay -\n\nPayments made via Alipay.\n\\* dotpay -\n\ndotpay\n\\* giropay -\n\ngiropay\n\\* sofort -\n\nsofort\n\\* sepa_instant_transfer -\n\nSepa Instant Transfer\n\\* paypay - \\* gcash - \\* kakao_pay -\n\nPayments made via Kakao Pay.\n\\* direct_debit -\n\ndirect_debit\n\\* paypal_express_checkout -\n\npaypal_express_checkout\n\\* boleto -\n\nboleto\n\\* faster_payments -\n\nFaster Payments\n\\* pix -\n\nPix\n\\* klarna_pay_now -\n\nKlarna Pay Now\n\\* revolut_pay -\n\nPayments made via Revolut Pay.\n\\* naver_pay -\n\nPayments made via Naver Pay.\n\\* amazon_payments -\n\nAmazon Payments\n\\* electronic_payment_standard -\n\nElectronic Payment Standard\n\\* stablecoin -\n\nPayments made via Stablecoin.\n\\* grab_pay -\n\nPayments made via GrabPay\n\\* card -\n\ncard\n\\* upi -\n\nupi\n\\* south_korean_cards - \\* online_banking_poland - \\* klarna -\n\nPayments made via Klarna.\n\\* pay_by_bank -\n\nPay By Bank\n\\* go_pay -\n\nPayments made via GoPay\n\\* swish -\n\nPayments made via Swish\n\\* payconiq_by_bancontact -\n\nPayments made via Payconiq by Bancontact.\n\\* twint -\n\nPayments made via Twint\n\\* payme -\n\nPayments made via PayMe\n\\* wechat_pay -\n\nPayments made via WeChat Pay.\n\\* kbc_payment_button -\n\nKBC 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" ], "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.
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.
Resource object representing payment_intent
" } }, "required" : [ "payment_intent" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/payment_intents" : { "post" : { "summary" : "Create a payment intent", "description" : "Creates a PaymentIntent object. This is to be used with Chargebee.js API to complete the 3DS flow for new or stored cards.
While creating, specify the appropriate gateway account and amount. Exact amount can be estimated using our Estimate API.
When 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.
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.
See also
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.
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.
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.
Resource object representing payment_intent
" } }, "required" : [ "payment_intent" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/custom_field_configs/retrieve" : { "get" : { "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\\* customer -\n\nEntity that represents a customer.\n\\* invoice -\n\nEntity that represents an invoice.\n\\* addon_item -\n\nEntity that represents item of type addon.\n\\* plan -\n\nEntity that represents a subscription plan.\n\\* subscription -\n\nEntity that represents a subscription of a customer.\n\\* charge_price -\n\nEntity that represents charge price.\n\\* item_family -\n\nEntity that represents item family.\n\\* addon -\n\nEntity that represents an addon.\n\\* addon_price -\n\nEntity that represents addon price.\n\\* credit_note -\n\nEntity that represents a credit note.\n\\* charge_item -\n\nEntity that represents item of type charge.\n\\* plan_item -\n\nEntity that represents item of type plan.\n\\* plan_price -\n\nEntity 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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-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.
" } }, "required" : [ "custom_field_config" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/custom_field_configs" : { "get" : { "summary" : "List custom field configs", "description" : "Lists the configurations for all [custom fields](/docs/api/advanced-features#custom-fields) defined for the specified entity type.\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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "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.
Resource object representing configuration
", "items" : { "$ref" : "#/components/schemas/Configuration", "description" : "Resource object representing configuration" }, "example" : null } }, "required" : [ "configurations" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/in_app_subscriptions/{in-app-subscription-app-id}/retrieve" : { "post" : { "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.
in_app_subscription_app_id
required, string
The handle is created by Chargebee for your Apple App Store or Google Play Store app. It can be obtained from the Chargebee web app.\nThe following are instructions to obtain the value of the path parameter for the Apple App Store and Google Play Store.
{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.{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.Apple App Store: The Base64 encoded App Store in-app purchase receipt taken from the Apple device after successful creation of the in-app purchase subscription.\nGoogle Play Store: The purchase token taken from the Android device after the successful creation of an in-app purchase subscription.
Array of in_app_subscription object
", "items" : { "$ref" : "#/components/schemas/InAppSubscription", "description" : "Resource object representing in_app_subscription" }, "example" : null } }, "required" : [ "in_app_subscriptions" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/in_app_subscriptions/{in-app-subscription-app-id}/import_receipt" : { "post" : { "summary" : "Import receipt", "description" : "Verifies an Apple App Store or Google Play Store in-app purchase receipt and imports subscriptions for all historical purchases made by the customer.
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.
CSV upload has a file size limitation 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.
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.
This section provides details of the Import Receipt operation performed for the Apple App Store. This API processes only the historical in-app transaction receipts.
Important
Chargebee validates the receipt with Apple App Store and does the following once validation succeeds:
Subscriptions are imported as follows:
original_transaction_id in the Apple receipt.\nNote: This is not done for original_transaction_ids for which a subscription already exists in Chargebee.id set to original_transaction_id.start_date set to the earliest purchase_date_ms.current_term_start set to latest purchase_date_ms.current_term_end set to expires_date_ms of the same Latest_receipt_info element with the latest purchase_date_ms.plan_id set to product_id.status set to in_trial if there is only one element of Latest_receipt_info 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.Invoices are imported as follows:
Latest_receipt_info which has is_trial_period as false.subscription_id set to original_transaction_id.A transaction is imported for each invoice with the following details:
reference_number set to the transaction_id.payment_method set to apple_store.This section provides details of the Import Receipt operation performed for the Google Play Store. This API is used to process only the historical in-app purchase subscriptions.
Important
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.token expires, an API request to Google Developers API returns an error.Chargebee validates the purchase token with Google Play Store and does the following once validation succeeds:
A subscription is imported for every unique purchase token if it is not linked to an existing purchase token( linkedPurchaseToken field in SubscriptionsV2.get API Response).
Each subscription imported has the following attributes set:
\nid set to a unique identifier generated by Chargebee and mapped to the token and latestOrderId of the SubscriptionPurchaseV2 object from Google response.
start_date set to the earliest SubscriptionPurchaseV2.startTime.
current_term_start set to latest SubscriptionPurchaseV2.startTime.
current_term_end set to expiryTime of the same SubscriptionPurchaseV2 element with the latest purchase.
plan_id set to the concatenation of product[id] and priceCurrencyCode from Google.
status set to in_trial if the free trial configuration is enabled in Google and the monetization.subscriptions.basePlans.offers.State is Active with a SubscriptionOfferPhase.duration, then consider the subscription is currently in trial. No invoices are created for this subscription.
Invoices are imported as follows:
An invoice is imported to Chargebee for every new subscription and renewal of an existing subscription using latestOrderId.
Each imported invoice has the subscription_id set to a unique identifier generated by Chargebee and mapped to the token and latestOrderId.
A transaction is imported for each invoice with the following details:
transaction.reference_number is set to the latestOrderId.
transaction.payment_method is set to play_store.
{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.
{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.{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.Apple App Store: The Base64 encoded App Store in-app purchase receipt taken from the Apple device after successful creation of the in-app purchase subscription.\nGoogle Play Store: The purchase token taken from the Android device after the successful creation of an in-app purchase subscription.
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.\nGoogle 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.
Array of in_app_subscription object
", "items" : { "$ref" : "#/components/schemas/InAppSubscription", "description" : "Resource object representing in_app_subscription" }, "example" : null } }, "required" : [ "in_app_subscriptions" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/in_app_subscriptions/{in-app-subscription-app-id}/import_subscription" : { "post" : { "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 API.\nWith this API, you can import subscriptions and corresponding invoices for historic In-App purchases. The API returns the in-app-subscriptions object once the historic subscription is successfully imported into Chargebee.
Note:
This section provides details of the Import Subscription operation when performed for the Apple App Store. This API creates a historic subscription if the incoming subscription is unknown. For a known subscription, it creates an invoice for the mentioned period.
Important
Integrate Chargebee with your Apple App Store account using your shared secret from Apple.
\nIt is strongly recommended to use this endpoint to create a historic In-App subscription only.
\nYou must import App Store products using Chargebee's user interface before importing receipts using this API.
\nChargebee validates the application ID with Apple App Store and does the following once validation succeeds:
Import the subscription from the latest_receipt_info array from Apple, and a new subscription is imported for the item-price.\nNote: 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.
Each subscription imported has the following attribute set:
\nid set to subscription[id] . This subscription[id] is the original_transaction_id in the receipts.
start_date set to subscription[start_date]. You need to provide this information from the oldest Latest_receipt_info.purchase_date_ms.
term_start set to subscription[term_start]. You need to provide this information from the oldest Latest_receipt_info.purchase_date_ms).
term_end set to subscription[term_end]. You need to provide this information from the oldest Latest_receipt_info.expires_date_ms.
plan_id set to subscription[product_id] + subscription[currency_code]. You need to provide this information from the Latest_receipt_info.product_id.
Chargebee records the subscription in a Trial state if the is_trial_period is true.
Chargebee records the subscription in a Canceled state if the term_end is less than the System.currentTime().
subscription_id set to original_transaction_id.The transaction.reference_number is set to the transaction_id of the payment.
The transaction.payment_method is set to apple_store.
in_app_subscription_app_id
required, string
The handle created by Chargebee for your App Store app. It can be obtained from within the Chargebee web app. To obtain the value of 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.
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. The latest_receipt_info is an array that contains all in-app purchase transactions.
The time at which the subscription has started or going to be started. You can find this value from the oldest purchase_date_ms.
Start date of the billing period for the subscription. You can find it from the purchase_date_ms field in receipt payload.
End date of the billing period for the subscription. You can find it from the expires_date_ms field in receipt payload.
Transaction ID value as mentioned in the latest_receipt_info.\nThis must be unique across subscriptions.
Indicates if the subscription is in trial for the term start and term end. The default value is false\n.
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.
Resource object representing in_app_subscription
" } }, "required" : [ "in_app_subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/in_app_subscriptions/{in-app-subscription-app-id}/process_purchase_command" : { "post" : { "summary" : "Process purchase command", "description" : "Verifies an in-app purchase made by your customer and creates a subscription in Chargebee.
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 API, importing products is mandatory. Learn more.
This section provides details of the Process Purchase Command operation when performed for the Apple App Store. This API processes only the latest in-app transaction on the receipt. Sync historical subscriptions into Chargebee using bulk import of In-App Purchase receipts.
Important
Chargebee validates the receipt with Apple App Store and does the following once validation succeeds:
plan_id that matches the concatenation of product[id] and priceCurrencyCode from Apple, and if not found, create such a plan.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:
\nid set to original_transaction_id
start_date set to responseBody.Latest_receipt_info.purchase_date_ms
current_term_end set to responseBody.Latest_receipt_info.expires_date_ms
Instead, if the receipt belongs to an existing subscription in Chargebee, it is updated to reflect the current state of the subscription at Apple.
\ntransaction.reference_number is set to the transaction_id of the payment.transaction.payment_method is set to apple_pay.This section provides details of the Process Purchase Command operation when performed for the Google Play Store. This API processes only the latest in-app transaction using the purchase token.
Important
Chargebee validates the token with Google Play Store and does the following once validation succeeds:
plan_id that matches the concatenation of product[id] and priceCurrencyCode from Google, and if not found, create such a plan.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:
\nid set to set to unique identifier generated by Chargebee and mapped to token of the SubscriptionPurchase object from Google response.
start_date set to SubscriptionPurchase.startTimeMillis.
current_term_end set to SubscriptionPurchase.expiryTimeMillis.
Instead, if the token belongs to an existing subscription in Chargebee, it is updated to reflect the current state of the subscription at Google.
\ntransaction.reference_number is set to the orderId of the payment.transaction.payment_method is set to play_store.{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.
{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.{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.Apple App Store: The Base64 encoded App Store in-app purchase receipt taken from the Apple device after successful creation of the in-app purchase subscription.\nGoogle Play Store: The purchase token taken from the Android device after the successful creation of an in-app purchase subscription.
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.
Note:\nThe max chars\nlimit is 95\nfor Google Play Store.
Apple App Store:\nThe unique identifier\n(created in App Store Connect\n) of the product purchased.
", "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.
\nApple App Store:\nThe price paid by the customer for this product. The unit depends on the type of currency. Provide either this or product[price_in_decimal].
Note:
product[price] is passed through this API then it will override the product price configured in Chargebee while creating a subscription.product[price] is passed and the product[id] does not exist in Chargebee then this API will return an error.product[price] passed through this API.Google Play Store:\nThe name (created in Play Store Console\n) of the product purchased. If not passed then the product[id]\nwill be considered as the value of product[name]\n.
optional, string, max chars=46
\nApple App Store:\nThe name (created in App Store Connect\n) of the product purchased.
", "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.
\nApple 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.
Google Play Store:\nThis parameter is not applicable\nto the Google Play Store. If the value is passed, it will return a validation error.
\nApple 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.
Google Play Store:\nThis parameter is not applicable\nto the Google Play Store. If the value is passed, it will return a validation error.
\nApple 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.
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.
Google Play Store:\nThe unique 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.
optional, string, max chars=50
\nApple App Store:\nThe unique id\nin Chargebee for the customer who made this purchase. If not provided, the value is considered to be original_transaction_id\n(the transaction identifier at Apple, of the original purchase). If the customer record is not found in Chargebee, it is created.
Resource object representing in_app_subscription
" } }, "required" : [ "in_app_subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/non_subscriptions/{non-subscription-app-id}/one_time_purchase" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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.
Apple App Store:\nThe Base64 encoded App Store in-app purchase receipt\ntaken from the Apple device after successful creation of the in-app purchase.
", "maxLength" : 65000, "example" : null }, "product" : { "type" : "object", "deprecated" : false, "description" : "Parameters for product\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.
Note:\nThe max chars\nlimit is 95\nfor the Google Play Store.
Apple App Store: The unique identifier (created in App Store Connect) of the product purchased.
", "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.
\nApple App Store:\nThe price paid by the customer for this product. The unit depends on the type of currency.\nProvide either this or product[price_in_decimal]\n.
Google Play Store:\nThe name (created in Play Store Console\n) of the product purchased. If not passed then the product[id]\nwill be considered as the value of product[name].
Apple App Store:\nThe name (created in App Store Connect\n) of the product purchased.
", "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.
\nApple 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].
Google Play Store:\nThe unique 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.
Apple App Store:\nThe unique id\nin Chargebee for the customer who made this purchase. If not provided, the value is considered to be original_transaction_id\n(the transaction identifier at Apple, of the original purchase). If the customer record is not found in Chargebee, it is created.
Resource object representing non_subscription
" } }, "required" : [ "non_subscription" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/customers/{customer-id}/payment_vouchers" : { "get" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "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.
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.
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.
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.
Retrieves a voucher using the unique payment_voucher_id\n.
Resource object representing payment_voucher
" } }, "required" : [ "payment_voucher" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/payment_vouchers" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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\\* boleto -\n\nThe 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
Resource object representing payment_voucher
" } }, "required" : [ "payment_voucher" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/csv_tax_rules" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "enum" : [ "all-disabled" ], "example" : null } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "tax_profile_name" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "country" : { "type" : "string", "deprecated" : false, "maxLength" : 50, "example" : null }, "state" : { "type" : "string", "default" : "*", "deprecated" : false, "maxLength" : 50, "example" : null }, "zip_code" : { "type" : "string", "deprecated" : false, "maxLength" : 50, "example" : null }, "zip_code_start" : { "type" : "integer", "format" : "int32", "deprecated" : false, "example" : null }, "zip_code_end" : { "type" : "integer", "format" : "int32", "deprecated" : false, "example" : null }, "tax1_name" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "tax1_rate" : { "type" : "number", "format" : "double", "deprecated" : false, "maximum" : 100, "minimum" : 0, "example" : null }, "tax1_juris_type" : { "type" : "string", "deprecated" : false, "enum" : [ "country", "federal", "state", "county", "city", "special", "unincorporated", "other" ], "example" : null }, "tax1_juris_name" : { "type" : "string", "deprecated" : false, "maxLength" : 250, "example" : null }, "tax1_juris_code" : { "type" : "string", "deprecated" : false, "maxLength" : 250, "example" : null }, "tax2_name" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "tax2_rate" : { "type" : "number", "format" : "double", "deprecated" : false, "maximum" : 100, "minimum" : 0, "example" : null }, "tax2_juris_type" : { "type" : "string", "deprecated" : false, "enum" : [ "country", "federal", "state", "county", "city", "special", "unincorporated", "other" ], "example" : null }, "tax2_juris_name" : { "type" : "string", "deprecated" : false, "maxLength" : 250, "example" : null }, "tax2_juris_code" : { "type" : "string", "deprecated" : false, "maxLength" : 250, "example" : null }, "tax3_name" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "tax3_rate" : { "type" : "number", "format" : "double", "deprecated" : false, "maximum" : 100, "minimum" : 0, "example" : null }, "tax3_juris_type" : { "type" : "string", "deprecated" : false, "enum" : [ "country", "federal", "state", "county", "city", "special", "unincorporated", "other" ], "example" : null }, "tax3_juris_name" : { "type" : "string", "deprecated" : false, "maxLength" : 250, "example" : null }, "tax3_juris_code" : { "type" : "string", "deprecated" : false, "maxLength" : 250, "example" : null }, "tax4_name" : { "type" : "string", "deprecated" : false, "maxLength" : 100, "example" : null }, "tax4_rate" : { "type" : "number", "format" : "double", "deprecated" : false, "maximum" : 100, "minimum" : 0, "example" : null }, "tax4_juris_type" : { "type" : "string", "deprecated" : false, "enum" : [ "country", "federal", "state", "county", "city", "special", "unincorporated", "other" ], "example" : null }, "tax4_juris_name" : { "type" : "string", "deprecated" : false, "maxLength" : 250, "example" : null }, "tax4_juris_code" : { "type" : "string", "deprecated" : false, "maxLength" : 250, "example" : null }, "service_type" : { "type" : "string", "deprecated" : false, "enum" : [ "digital", "other", "not_applicable" ], "example" : null }, "time_zone" : { "type" : "string", "deprecated" : false, "maxLength" : 4, "example" : null }, "valid_from" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "example" : null }, "valid_till" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "example" : null }, "overwrite" : { "type" : "boolean", "default" : false, "deprecated" : false, "example" : null } }, "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "csv_tax_rule" : { "$ref" : "#/components/schemas/CsvTaxRule", "description" : "Resource object representing csv_tax_rule" } }, "required" : [ "csv_tax_rule" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/currencies/{site-currency-id}/add_schedule" : { "post" : { "summary" : "Add schedule", "description" : "This API is used to schedule exchange rate modification for a manual\nforex_type\ncurrency.
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.
Resource object representing currency
" } }, "required" : [ "currency", "scheduled_at" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/currencies" : { "post" : { "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\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.
This represents the exchange rate type set for the currency.
\n* auto -If forex_type\nis auto\n, conversion rate will be auto updated by Chargebee every day with third party providers (using external currency conversion providers)
If forex_type\nis 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
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.
Resource object representing currency
" } }, "required" : [ "currency" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/currencies/{site-currency-id}" : { "get" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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
" } }, "required" : [ "currency" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] }, "post" : { "summary" : "Update a currency", "description" : "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.
This represents the exchange rate type set for the currency.
\n* auto -If forex_type\nis auto\n, conversion rate will be auto updated by Chargebee every day with third party providers (using external currency conversion providers)
If forex_type\nis 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
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.
Resource object representing currency
" } }, "required" : [ "currency" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/currencies/{site-currency-id}/remove_schedule" : { "post" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$" } }, { "name" : "chargebee-event-actions", "in" : "header", "description" : "skip all actions to be done on the events\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-actions", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip all actions to be done on the events\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-email", "in" : "header", "description" : "skip only emails\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-email", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only emails\n", "enum" : [ "all-disabled" ], "example" : null } }, { "name" : "chargebee-event-webhook", "in" : "header", "description" : "skip only webhooks\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-event-webhook", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "skip only webhooks\n", "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" : "", "example" : null }, "currency" : { "$ref" : "#/components/schemas/Currency", "description" : "Resource object representing currency
" } }, "required" : [ "currency", "scheduled_at" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ] } }, "/currencies/list" : { "get" : { "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\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-device", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request\n", "example" : "Android" } }, { "name" : "chargebee-request-origin-user", "in" : "header", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The email address of your customer/user. Use this when the email address has only ASCII characters.\n", "example" : "user@example.com" } }, { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-user-encoded", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.\n", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, { "name" : "chargebee-request-origin-ip", "in" : "header", "description" : "The IP address of the customer where the request originated\n", "required" : false, "deprecated" : false, "$ref" : "#/components/parameters/chargebee-request-origin-ip", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The IP address of the customer where the request originated\n", "example" : "192.168.1.2", "pattern" : "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-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" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.\n", "maximum" : 100, "minimum" : 1, "example" : null } }, { "name" : "offset", "in" : "query", "description" : "", "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.\n", "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.
List of best offers to be shown to the customer. Currently this will always return one personalized offer. This will be empty if no best offers are found.
", "items" : { "$ref" : "#/components/schemas/PersonalizedOffer", "description" : "Resource object representing personalized_offer" }, "example" : null }, "brand" : { "$ref" : "#/components/schemas/Brand", "description" : "Resource object representing brand
" }, "expires_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "The timestamp until which the offer remains active. After this time, you must retrieve the offer again via the List Personalised Offers API to get the latest.
", "example" : null } }, "required" : [ "expires_at", "personalized_offers" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ], "servers" : [ { "url" : "{protocol}://{site}.grow.{environment}:{port}/api/v2", "variables" : { "protocol" : { "default" : "https", "enum" : [ "http", "https" ] }, "site" : { "default" : "demo" }, "environment" : { "default" : "chargebee.com", "enum" : [ "chargebee.com" ] }, "port" : { "default" : "443", "enum" : [ "443", "8080" ] } } }, { "url" : "{protocol}://{site}-test.grow.{environment}:{port}/api/v2", "variables" : { "protocol" : { "default" : "https", "enum" : [ "http", "https" ] }, "site" : { "default" : "demo" }, "environment" : { "default" : "chargebee.com", "enum" : [ "chargebee.com" ] }, "port" : { "default" : "443", "enum" : [ "443", "8080" ] } } } ] } }, "/offer_fulfillments" : { "post" : { "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:
billing_update: Initiates subscription or billing record updates (e.g., applying a discount or changing a plan) asynchronously.checkout: Returns a hosted_page object in the response, which contains a URL to render the hosted checkout flow.url_redirect: Returns a redirect_url. You are responsible for managing fulfillment on your end and must call the Update Offer Fulfillment API to report either completion or failure.webhook: Sends a webhook, and you must also manage fulfillment on your end. Be sure to call the Update Offer Fulfillment API to report completion or failure.email: Sends an email containing the offer details as configured. You are responsible for handling fulfillment on your side and must call the Update Offer Fulfillment API to report completion or failure.\nYou can poll the Retrieve Offer Fulfillment endpoint for final status on billing_update and checkout flows.\nUpon actual fulfillment completion, the system logs a fulfilled event and sends notifications (webhook, Slack, email, Segment) as configured.Represents the fulfillment created for the offer.
" }, "hosted_page" : { "$ref" : "#/components/schemas/HostedPage", "description" : "Represents the hosted page created for the offer. This is returned only if the selected offer option's processing_type\nis checkout.
Represents the fulfillment created for the offer.
" } }, "required" : [ "offer_fulfillment" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ], "servers" : [ { "url" : "{protocol}://{site}.grow.{environment}:{port}/api/v2", "variables" : { "protocol" : { "default" : "https", "enum" : [ "http", "https" ] }, "site" : { "default" : "demo" }, "environment" : { "default" : "chargebee.com", "enum" : [ "chargebee.com" ] }, "port" : { "default" : "443", "enum" : [ "443", "8080" ] } } }, { "url" : "{protocol}://{site}-test.grow.{environment}:{port}/api/v2", "variables" : { "protocol" : { "default" : "https", "enum" : [ "http", "https" ] }, "site" : { "default" : "demo" }, "environment" : { "default" : "chargebee.com", "enum" : [ "chargebee.com" ] }, "port" : { "default" : "443", "enum" : [ "443", "8080" ] } } } ] }, "post" : { "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.\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.\nNote: 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.
Explanation for failure; required when status\n= failed\n.
Represents the fulfillment created for the offer.
" } }, "required" : [ "offer_fulfillment" ], "example" : null } } } }, "400" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/400" } } } }, "401" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/401" } } } }, "403" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/403" } } } }, "404" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/404" } } } }, "405" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/405" } } } }, "409" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/409" } } } }, "422" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/422" } } } }, "429" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/429" } } } }, "500" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/500" } } } }, "503" : { "description" : "on error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/503" } } } } }, "deprecated" : false, "security" : [ { "BasicAuth" : [ ] } ], "servers" : [ { "url" : "{protocol}://{site}.grow.{environment}:{port}/api/v2", "variables" : { "protocol" : { "default" : "https", "enum" : [ "http", "https" ] }, "site" : { "default" : "demo" }, "environment" : { "default" : "chargebee.com", "enum" : [ "chargebee.com" ] }, "port" : { "default" : "443", "enum" : [ "443", "8080" ] } } }, { "url" : "{protocol}://{site}-test.grow.{environment}:{port}/api/v2", "variables" : { "protocol" : { "default" : "https", "enum" : [ "http", "https" ] }, "site" : { "default" : "demo" }, "environment" : { "default" : "chargebee.com", "enum" : [ "chargebee.com" ] }, "port" : { "default" : "443", "enum" : [ "443", "8080" ] } } } ] } }, "/offer_events" : { "post" : { "summary" : "Create an offer event", "description" : "The Create Offer Event API records user interactions with an offer for tracking and analytics purposes.\nUse this API to log user-triggered engagement events such as:
viewed - when an offer is displayed to the user.dismissed - when the user closes or ignores the offer.\nThese events are essential for accurate offer performance reporting and funnel analysis. Make sure to send them as they happen.Note: System-driven events like accepted and fulfilled are captured automatically by the growth system through fulfillment workflows. You do not need to post these.
The webhook_endpoint\nresource object that contains the configuration and details of the created webhook.
The webhook_endpoint\nresource object that contains the configuration and details of the created webhook.
The target URL where webhook notifications will be sent.
\nNote\nOnly URL ports 80, 443, 8080, or 8443 are allowed.
Indicates whether the webhook endpoint is disabled. Set to true\nto disable the endpoint, set to false\nto enable the endpoint.
The webhook_endpoint\nresource object that contains the configuration and details of the created webhook.
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.
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.
The target URL where webhook notifications will be sent.
\nNote\nOnly URL ports 80, 443, 8080, or 8443 are allowed.
Indicates whether the webhook endpoint is disabled. Set to true\nto disable the endpoint, set to false\nto enable the endpoint.
Indicates the response schema used in the webhook payload, based on the product catalog version configured for the site.
\nNote\nThis field is only applicable if the site is in compat mode.
The webhook payload follows the Product Catalog 2.0\nschema and uses the Items API model\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 -The webhook payload follows the Product Catalog 1.0\nschema and uses the Plans\nand Addons\nmodel.
", "enum" : [ "plans_addons", "items", "compat" ], "example" : null }, "enabled_events" : { "type" : "array", "deprecated" : false, "description" : "A list of event types that trigger this webhook. \n**Note**\nIf this field is left empty, the webhook will enable [all event types](/docs/api/v2/pcv-1/webhook_endpoints) by default.\n", "items" : { "type" : "string", "deprecated" : false, "enum" : [ "plan_created", "plan_updated", "plan_deleted", "addon_created", "addon_updated", "addon_deleted", "coupon_created", "coupon_updated", "coupon_deleted", "coupon_set_created", "coupon_set_updated", "coupon_set_deleted", "coupon_codes_added", "coupon_codes_deleted", "coupon_codes_updated", "customer_created", "customer_changed", "customer_deleted", "customer_moved_out", "customer_moved_in", "promotional_credits_added", "promotional_credits_deducted", "subscription_created", "subscription_created_with_backdating", "subscription_started", "subscription_trial_end_reminder", "subscription_activated", "subscription_activated_with_backdating", "subscription_changed", "subscription_trial_extended", "mrr_updated", "subscription_changed_with_backdating", "subscription_cancellation_scheduled", "subscription_cancellation_reminder", "subscription_cancelled", "subscription_canceled_with_backdating", "subscription_reactivated", "subscription_reactivated_with_backdating", "subscription_renewed", "subscription_items_renewed", "subscription_scheduled_cancellation_removed", "subscription_changes_scheduled", "subscription_scheduled_changes_removed", "subscription_shipping_address_updated", "subscription_deleted", "subscription_paused", "subscription_pause_scheduled", "subscription_scheduled_pause_removed", "subscription_resumed", "subscription_resumption_scheduled", "subscription_scheduled_resumption_removed", "subscription_advance_invoice_schedule_added", "subscription_advance_invoice_schedule_updated", "subscription_advance_invoice_schedule_removed", "pending_invoice_created", "pending_invoice_updated", "invoice_generated", "invoice_generated_with_backdating", "invoice_updated", "invoice_deleted", "credit_note_created", "credit_note_created_with_backdating", "credit_note_updated", "credit_note_deleted", "subscription_renewal_reminder", "transaction_created", "transaction_updated", "transaction_deleted", "payment_succeeded", "payment_failed", "dunning_updated", "payment_refunded", "payment_initiated", "refund_initiated", "authorization_succeeded", "authorization_voided", "card_added", "card_updated", "card_expiry_reminder", "card_expired", "card_deleted", "payment_source_added", "payment_source_updated", "payment_source_deleted", "payment_source_expiring", "payment_source_expired", "payment_source_locally_deleted", "virtual_bank_account_added", "virtual_bank_account_updated", "virtual_bank_account_deleted", "token_created", "token_consumed", "token_expired", "unbilled_charges_created", "unbilled_charges_voided", "unbilled_charges_deleted", "unbilled_charges_invoiced", "order_created", "order_updated", "order_cancelled", "order_delivered", "order_returned", "order_ready_to_process", "order_ready_to_ship", "order_deleted", "order_resent", "quote_created", "quote_updated", "quote_deleted", "tax_withheld_recorded", "tax_withheld_deleted", "tax_withheld_refunded", "gift_scheduled", "gift_unclaimed", "gift_claimed", "gift_expired", "gift_cancelled", "gift_updated", "hierarchy_created", "hierarchy_deleted", "payment_intent_created", "payment_intent_updated", "contract_term_created", "contract_term_renewed", "contract_term_terminated", "contract_term_completed", "contract_term_cancelled", "voucher_created", "voucher_expired", "voucher_create_failed", "subscription_ramp_created", "subscription_ramp_deleted", "subscription_ramp_applied", "subscription_ramp_drafted", "subscription_ramp_updated", "subscription_moved_in", "subscription_moved_out", "subscription_movement_failed", "omnichannel_subscription_created", "omnichannel_subscription_item_renewed", "omnichannel_subscription_item_downgraded", "omnichannel_subscription_item_expired", "omnichannel_subscription_item_cancellation_scheduled", "omnichannel_subscription_item_scheduled_cancellation_removed", "omnichannel_subscription_item_resubscribed", "omnichannel_subscription_item_upgraded", "omnichannel_subscription_item_cancelled", "omnichannel_subscription_imported", "omnichannel_subscription_item_grace_period_started", "omnichannel_subscription_item_grace_period_expired", "omnichannel_subscription_item_dunning_started", "omnichannel_subscription_item_dunning_expired", "rule_created", "rule_updated", "rule_deleted", "record_purchase_failed", "omnichannel_subscription_item_change_scheduled", "omnichannel_subscription_item_scheduled_change_removed", "omnichannel_subscription_item_reactivated", "sales_order_created", "sales_order_updated", "omnichannel_subscription_item_changed", "omnichannel_subscription_item_paused", "omnichannel_subscription_item_resumed", "omnichannel_one_time_order_created", "omnichannel_one_time_order_item_cancelled", "omnichannel_subscription_item_pause_scheduled" ], "example" : null }, "example" : null } }, "required" : [ "name", "url" ], "example" : null }, "encoding" : { } } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "properties" : { "webhook_endpoint" : { "$ref" : "#/components/schemas/WebhookEndpoint", "description" : "The webhook_endpoint\nresource object that contains the configuration and details of the created webhook.
Used exclusively with the following accounting integrations
\n: . For example:Location: Singapore.::...: : .... For example: Services : Plan.Used exclusively with the following accounting integrations
\n: .... For example, Region: South::.... For example: Location: North America: Canada: : .... For example: NA:US:CAUsed exclusively with the following accounting integrations
\n: : .... For example: Production: Assembly.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.
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\nis enabled.
This 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\nis enabled.
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.
Note\nApplicable only for addons with pricing_model = per_unit.
Specifies how to manage charges or credits for the addon during a subscription update\nor estimating\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 -Use the site-wide proration setting\n.
\n* partial_term -Prorate the charges or credits for the rest of the current term.
", "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. \\*\\*Note:\\*\\* There's a character limit of 65,535. \\[Learn more\\](/docs/api/v2/pcv-1/advanced-features) .\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\n.
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\nis enabled.
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\nis enabled.
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\nis enabled.
The ISO 3166-2 state/province 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).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The invoice for a subscription in Chargebee is generated at the time of subscription renewal. Invoices can also be generated in advance 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:
Advance invoices can be scheduled in two ways:
Advance invoices for a subscription can be scheduled to be generated on specific dates in the future. You must specify the number of billing cycles to be invoiced on each date. A maximum of 5 dates can be specified.
Advance invoices can be scheduled to be generated at fixed intervals of time, where each interval spans the same number of billing cycles of the subscription. The invoice for each interval is generated a specified number of days (days_before_interval) before the start of the interval. You can configure the schedule to end on a certain date or after a specified number of advance invoices have been generated.
The start date of the first interval depends on the number of days remaining from current time till the next renewal of the subscription. If this is more than days_before_interval, the interval begins at the next renewal. On the other hand, if the number of days remaining before the next renewal is less than days_before_interval, the first interval begins at the renewal following the next.
System-generated and immutable unique Id for the advance_invoice_schedule\n.
When the schedule_type\nis fixed_intervals\n, this object gives further details of the schedule.
Specifies when the schedule should end.
\n* after_number_of_intervals -Advance invoices are generated a specified number of times
Advance invoices are generated for as long as the subscription is active.
\n* specific_date -End the advance invoicing schedule on a specific date\n.
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\nof the subscription. This parameter is applicable only when fixed_interval_schedule[end_schedule_on]\n= after_number_of_intervals
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]\n= specific_date\n.
The number of billing cycles to charge for, on the date specified. Applicable only when schedule_type\nis specific_dates.
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\nis specific_dates\n.
The ISO 3166-2 state/province 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).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
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.
The Chargebee site\nfor which the information has been requested. It is the same as the value of {site}\nprovided as a path parameter.
Subscriptions can run indefinitely or they may run for a fixed number of billing cycles. Subscription can have "contract terms", which define a lock-in period on the subscription for a certain number of billing cycles. This prevents the subscription from being canceled by the customer when it is within the contract term.
The contract term resource described below defines the properties of this lock-in period. This includes the number of billing cycles, the total contract value, the action to be taken at the end of the contract term, and so on. To allow for exceptions, you also have the option of terminating an active contract term and charging a termination fee.
A contract term starts in the active state and ends in the completed state. If the contract was canceled due to non-payment or other reasons, it can end in the canceled or terminated state. A given contract term is always associated with one, and only one subscription. A subscription, however, can be associated with only one active contract term. Over time, a subscription can be associated with several non-active contract terms. The active contract term for a subscription is available as an object within the subscription.
To enable and configure contract terms, follow these steps in the Chargebee UI:
Once contract terms have been configured, the following actions can be performed using the API:
Define a contract term for a subscription and set renewal options for the contract term. The following endpoints support this:
\nRetrieving a historical record of all contract terms for a subscription can be done via the following endpoint:
\nCanceling a contract term can be done via the following endpoints:
\nWhen a contract is canceled mid-term, you can set a termination fee to be levied. Here's how:
non_recurring addon.event_based_addons[on_event] parameter to contract_term_termination.Once the above steps are done, the termination fee will be charged automatically if you terminate the contract in the middle of its term.
Action to be taken when the contract term completes.
\n* renew -contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.Contract term completes and the subscription renews.
\n* renew_once -Used when you want to renew the contract term just once. Does the following: - Contract term completes and a new contract term is started for the number of billing cycles specified in contract_billing_cycle_on_renewal.
action_at_term_end for the new contract term is set to cancel.Contract term completes and subscription is canceled.
", "enum" : [ "renew", "evergreen", "cancel", "renew_once" ], "example" : null }, "total_contract_value" : { "type" : "integer", "format" : "int64", "default" : 0, "deprecated" : false, "description" : "The sum of the totals\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.\nIf the subscription was imported\nwith the contract term, then this value includes the value passed for total_amount_raised\n.
The number of days before 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.
The number of subscription billing cycles remaining after the current one for the contract term. This attribute is only returned for active\ncontract terms.
Coupons 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.
When multiple coupons are applied to a subscription or one-time invoice, they're applied in the following order:
| Summary | Description | |
|---|---|---|
| 1 | Line-level, fixed amount coupons | coupon with apply_on = each_specified_item and discount_type = flat |
| 2 | Line-level, percentage coupons | coupon with apply_on = each_specified_item and discount_type = percentage |
| 3 | Invoice-level, fixed amount coupons | coupon with apply_on = invoice_amount and discount_type = flat |
| 4 | Invoice-level, percentage coupons | coupon with apply_on = invoice_amount and discount_type = percentage |
For example, consider the following scenario:
A subscription is created with:
The above coupons are applied in the following order:
| Discount or coupon applied | Subtotal at each step | |
|---|---|---|
| 1 | Initial subtotal (plan price + addon price) | $200 + $20 = $220 |
| 2 | Flat $10 coupon on the plan | $(200 - 10) + $20 = $190 + $20 = $210 |
| 3 | 1% off coupon on the addon | $190 + $(20 - 0.2) = $190 + $19.8 = $209.8 |
| 4 | Flat $5 coupon on the invoice | $209.8 - $5 = $204.8 |
Used to uniquely identify the coupon in your website/application and to integrate with Chargebee.
\nNote:
When the coupon ID contains a special character; for example: #, the API returns an error. Make sure that you encode the coupon ID in the path parameter before making an API call.
The display name used in web interface for identifying the coupon.
\nNote:
When the name of the coupon set contains a special character; for example: #, the API returns an error. Make sure that you encode the name of the coupon set in the path parameter before making an API call.
Specifies the type of discount to be applied.
\n* percentage -A percentage of the original price is deducted as a discount. The discount percentage is specified in discount_percentage.
Learn more\nabout percentage\ncoupons.
A fixed amount is deducted as a discount. The discount amount is specified in discount_amount.
Learn more\nabout fixed_amount\ncoupons.
A specified number of units of the plan or addon are offered for free. The number of free units is specified in discount_quantity.\nThe offer_quantity\noption is valid only when apply_on\nis set to each_specified_item\nand the pricing_model\nof the plan\nor addon is per_unit.
Learn more\nabout offer_quantity\ncoupons.
Specifies the number of free units provided for the plan\nor addon\n, without affecting the total quantity sold. This parameter is applicable only when the discount_type\nis set to offer_quantity\n.
Specifies the time duration for which this coupon is attached to the subscription.
\n* forever -The coupon is attached to the subscription and applied on the invoices until explicitly removed.
\n* one_time -The coupon stays attached to the subscription till it is applied on an invoice once.\nIt is removed after that from the subscription.
\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\nand period_unit\n.
Status of the coupon.
\n* expired -Cannot be applied to a subscription. A coupon may expire due to exceeding max_redemptions\nor valid_till\ndate is past. Existing associations remain unaffected.
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.
", "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* invoice_amount -The coupon is applied to the invoice sub_total\n.
The coupon is applied to the invoice.line_item.amount\nthat corresponds to the plan or addon specified by plan_ids\nand addon_ids\n.
The version number of this resource. For every change made to the resource, resource_version\nis updated with a new timestamp in milliseconds.
Timestamp indicating when this coupon was last updated.\nNote that this does not change when the redemptions\nattribute is changed. This attribute will be present only if the resource has been updated after 2016-11-09.
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.
The duration of time for which the coupon is attached to the subscription, in period_units.\nApplicable only when duration_type\nis limited_period\n.
The unit of time for period. Applicable only when duration_type\nis limited_period\n.
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.
", "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. \\*\\*Note:\\*\\* There's a character limit of 65,535. \\[Learn more\\](/docs/api/v2/pcv-1/advanced-features) .\n", "example" : null }, "deleted" : { "type" : "boolean", "deprecated" : false, "description" : "", "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\\* not_redeemed -\n\nCan be applied to a subscription.\n\\* redeemed -\n\nCannot be applied to a subscription as the coupon code has been already used.\n\\* archived -\n\nCannot 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\n", "example" : null }, "occurred_at" : { "type" : "integer", "format" : "int64", "description" : "Timestamp of the event\n", "example" : null }, "source" : { "type" : "string", "description" : "Source of the event\n", "example" : null }, "object" : { "type" : "string", "description" : "The object of the event\n", "example" : null }, "api_version" : { "type" : "string", "description" : "API version\n", "example" : null }, "event_type" : { "type" : "string", "description" : "Type of the event\n", "example" : null }, "webhook_status" : { "type" : "string", "description" : "Status of webhook\n", "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\n", "example" : null }, "occurred_at" : { "type" : "integer", "format" : "int64", "description" : "Timestamp of the event\n", "example" : null }, "source" : { "type" : "string", "description" : "Source of the event\n", "example" : null }, "object" : { "type" : "string", "description" : "The object of the event\n", "example" : null }, "api_version" : { "type" : "string", "description" : "API version\n", "example" : null }, "event_type" : { "type" : "string", "description" : "Type of the event\n", "example" : null }, "webhook_status" : { "type" : "string", "description" : "Status of webhook\n", "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\n", "example" : null }, "occurred_at" : { "type" : "integer", "format" : "int64", "description" : "Timestamp of the event\n", "example" : null }, "source" : { "type" : "string", "description" : "Source of the event\n", "example" : null }, "object" : { "type" : "string", "description" : "The object of the event\n", "example" : null }, "api_version" : { "type" : "string", "description" : "API version\n", "example" : null }, "event_type" : { "type" : "string", "description" : "Type of the event\n", "example" : null }, "webhook_status" : { "type" : "string", "description" : "Status of webhook\n", "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\n", "example" : null }, "occurred_at" : { "type" : "integer", "format" : "int64", "description" : "Timestamp of the event\n", "example" : null }, "source" : { "type" : "string", "description" : "Source of the event\n", "example" : null }, "object" : { "type" : "string", "description" : "The object of the event\n", "example" : null }, "api_version" : { "type" : "string", "description" : "API version\n", "example" : null }, "event_type" : { "type" : "string", "description" : "Type of the event\n", "example" : null }, "webhook_status" : { "type" : "string", "description" : "Status of webhook\n", "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\n", "example" : null }, "occurred_at" : { "type" : "integer", "format" : "int64", "description" : "Timestamp of the event\n", "example" : null }, "source" : { "type" : "string", "description" : "Source of the event\n", "example" : null }, "object" : { "type" : "string", "description" : "The object of the event\n", "example" : null }, "api_version" : { "type" : "string", "description" : "API version\n", "example" : null }, "event_type" : { "type" : "string", "description" : "Type of the event\n", "example" : null }, "webhook_status" : { "type" : "string", "description" : "Status of webhook\n", "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. \\*\\*Note:\\*\\* There's a character limit of 65,535. \\[Learn more\\](/docs/api/v2/pcv-1/advanced-features) .\n", "example" : null } }, "required" : [ "coupon_id", "id", "name" ], "example" : null }, "CouponSetCreatedEvent" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The ID of the event\n", "example" : null }, "occurred_at" : { "type" : "integer", "format" : "int64", "description" : "Timestamp of the event\n", "example" : null }, "source" : { "type" : "string", "description" : "Source of the event\n", "example" : null }, "object" : { "type" : "string", "description" : "The object of the event\n", "example" : null }, "api_version" : { "type" : "string", "description" : "API version\n", "example" : null }, "event_type" : { "type" : "string", "description" : "Type of the event\n", "example" : null }, "webhook_status" : { "type" : "string", "description" : "Status of webhook\n", "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\n", "example" : null }, "occurred_at" : { "type" : "integer", "format" : "int64", "description" : "Timestamp of the event\n", "example" : null }, "source" : { "type" : "string", "description" : "Source of the event\n", "example" : null }, "object" : { "type" : "string", "description" : "The object of the event\n", "example" : null }, "api_version" : { "type" : "string", "description" : "API version\n", "example" : null }, "event_type" : { "type" : "string", "description" : "Type of the event\n", "example" : null }, "webhook_status" : { "type" : "string", "description" : "Status of webhook\n", "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\n", "example" : null }, "occurred_at" : { "type" : "integer", "format" : "int64", "description" : "Timestamp of the event\n", "example" : null }, "source" : { "type" : "string", "description" : "Source of the event\n", "example" : null }, "object" : { "type" : "string", "description" : "The object of the event\n", "example" : null }, "api_version" : { "type" : "string", "description" : "API version\n", "example" : null }, "event_type" : { "type" : "string", "description" : "Type of the event\n", "example" : null }, "webhook_status" : { "type" : "string", "description" : "Status of webhook\n", "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\n", "example" : null }, "occurred_at" : { "type" : "integer", "format" : "int64", "description" : "Timestamp of the event\n", "example" : null }, "source" : { "type" : "string", "description" : "Source of the event\n", "example" : null }, "object" : { "type" : "string", "description" : "The object of the event\n", "example" : null }, "api_version" : { "type" : "string", "description" : "API version\n", "example" : null }, "event_type" : { "type" : "string", "description" : "Type of the event\n", "example" : null }, "webhook_status" : { "type" : "string", "description" : "Status of webhook\n", "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 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.
Credit 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. Use this type of credit note to reduce the invoice amount, typically as a discount to the customer.\nAdjustment credit notes are automatically created in the following cases:
payment_due or not_paid status.\n2. refundable: Refundable credit notes allow you to return a certain amount to the customer. These credits can be:paid status. Refundable credits are applied to future invoices or can be refunded to the original payment method.\n3. store: Store credit notes are created for paid or partially_paid invoice status during subscription changes, such as upgrades, downgrades, or cancellations.\nKey characteristics of store credits:Note:\nIf you have enabled consolidated invoicing\n, to know the subscriptions attached with a credit note you have to refer line_item's\nsubscription_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).
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.
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.
Note:
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.
An overridden value for the first two characters of the full VAT number.\nOnly applicable specifically for customers with billing_address
country\nas XI\n(which is United Kingdom - Northern Ireland\n).
When you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, you have the option of setting billing_address
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\nXI\nby default. However, if the VAT number was registered in UK, the value should be GB.\nSet\nvat_number_prefix\nto GB\nfor such cases.
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\nis enabled.
The decimal representation of the quantity of this line_item. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
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\nis enabled.
The reason due to which the line item price/amount is exempted from tax.
\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 -You are not registered for tax in the customer's region. This is also the reason code when both billing_address\nand shipping_address\nhave not been provided for the customer and subscription respectively
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.
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\nis enabled.
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\nis enabled.
The decimal representation of the quantity purchased from this tier. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
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\nis enabled.
The type of deduction and the amount to which it is applied.
\n* prorated_credits -The deduction is due to a legacy adjustment credit applied to the invoice. The entity_id\nis null\nin this case. The legacy credits feature is superseded by adjustment_credit_notes\n.
The deduction is due to a coupon applied to the invoice sub_total.\nThe coupon id\nis available as entity_id\n.
The deduction is due to a promotional credit\napplied to the invoice. The entity_id\nis null\nin this case.
The deduction is due to a coupon applied to a line item of the invoice. The coupon id\nis available as entity_id\n.
The ISO 3166-2 state/province 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).
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.
The type of deduction and the amount to which it is applied.
\n* prorated_credits -The deduction is due to a legacy adjustment credit applied to the invoice. The entity_id\nis null\nin this case. The legacy credits feature is superseded by adjustment_credit_notes\n.
The deduction is due to a coupon applied to line item. The coupon id\nis passed as entity_id\n.
The deduction is due to a coupon applied to the invoice sub_total.\nThe coupon id is passed as entity_id\n.
The deduction is due to a promotional credit\napplied to the invoice.
", "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.
The coupon code\n, if applicable, used to provide the discount. The coupon.id\nis available in entity_id\n.
The status of this transaction.
\n* needs_attention -When connection with the Gateway gets terminated abruptly. For needs_attention\nstatus Chargebee automatically reconcile the transaction for few gateways, for rest of the gateways you have to use the Reconcile transaction API.\nYou can use this API to update the id_at_gateway\n(Gateway Transaction ID) and status\nfor a needs_attention\ntransaction to be reconciled at par with the gateway.
Learn more\nabout needs_attention\ntransaction status
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 -Transaction is being processed by the gateway. This typically happens for direct debit transactions\nor, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method.
", "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\ncomponent of the invoice\nassociated\nwith this credit_note.
An auto-generated unique identifier for the tax withheld. The value starts with the prefix tax_wh_.\nFor example, tax_wh_16BdDXSlbu4uV1Ee6\n.
Current status of the invoice.
\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 -The invoice 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_invoicesattribute is set to true.\nThe invoice is yet to be closed (sent for payment collection). All invoices are generated with this status when Metered Billing is enabled for the site.
Indicates the payment is not yet collected and is being retried as per retry settings.
", "enum" : [ "paid", "posted", "payment_due", "not_paid", "voided", "pending" ], "example" : null }, "tax_application" : { "type" : "string", "deprecated" : false, "description" : "Specifies how tax is handled for invoice allocations made from this credit note.\n\\* pre_tax -\n\nAllocations are applied before tax calculation.\n\\* post_tax -\n\nAllocations 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\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).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The ISO 3166-2 state/province 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).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The unique id\nfor the e-invoice. This is auto-generated by Chargebee.
The status of processing the e-invoice. To obtain detailed information about the current status\n, see message\n.
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 -The e-invoice was not sent. This could be due to missing information or because the entity_identifier\nis not registered on the e-invoicing network.
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.
", "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:
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 to understand the multi-currency feature in Chargebee.
This currency resource contains exchange rate configurations associated with a specific currency. The multi-currency feature must be enabled, and all prerequisites must be addressed to successfully add a new currency via the API.\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.\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.
By default, the Chargebee API supports only whole numbers for currency values. To allow for fractional (decimal) values, you must enable the multi-decimal pricing 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.
By default, Chargebee supports currency values in whole numbers; fractions are not supported. In the API, currency values can be identified by checking their data types. For all whole number currency values in this API, the data type is indicated as "in cents" in this documentation.
The specific unit used for the currency in the API depends on whether it is a zero-decimal currency:
15.153.When multi-decimal pricing 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. For example, $1.6782 should be provided as 1.6782. The maximum number of decimal places supported by the API can be configured in the admin console.
Note: For zero-decimal currencies, such as the Japanese Yen (JPY), decimal places are not allowed.
While Chargebee supports multiple decimal places for currency values, at the invoice line item\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\nISO 4217 code\n.
The rounding logic used is ROUND_HALF_EVEN\n. For example, if the quantity\nis 0.0765 and unit_amount\nis $10.674, the line item amount\nis (0.0765 x $10.674) = $0.816561 and is rounded off to $0.82.
By default, Chargebee is able to process transactions in only one currency. However, you can enable the multi-currency 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 for assistance.
Warning
For 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.
The following endpoints require the currency_code\nparameter to be passed when the multi-currency feature has been enabled.
Customer-related endpoints
\nInvoice-related endpoints
\nProduct catalog-related endpoints
\nThis field mentions whether the foreign currency is active or archived. If the value is false\nthe foreign currency is archived else it is active
This represents the exchange rate type set for the currency.
\n* auto -If forex_type\nis auto\n, conversion rate will be auto updated by Chargebee every day with third party providers (using external currency conversion providers)
If forex_type\nis 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
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.
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.
Represents a customer, which can be an individual or organization that subscribes to your products or services. The customer resource associates with subscriptions, card information, and billing addresses. The customer details include their ID, name, contact information, and any custom attributes you'd like to associate with them.
Breaking Change:
billing_address and vat_number and replaces them with values from the request.billing_address and vat_number.The VAT/tax registration number for the customer. For customers with billing_address
country\nas\nXI\n(which is United Kingdom - Northern Ireland\n), the first two characters of the full VAT number\ncan be overridden by setting\nvat_number_prefix\n.
Specifies if the customer is liable for tax
\n* taxable -Computes tax for the customer based on the site configuration.\nIn 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 -entity_code or exempt_number attributes if you use Chargebee's AvaTax for Sales or specify exemption_details attribute if you use Chargebee's AvaTax for Communications 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.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.
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.
For example, the renewals happen on 15th July when billing_month is 7 and billing_date is 15.
Note\nApplicable when Calendar Billing (with customer-specific billing date support) is enabled and billing_date_mode is manually_set.
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.
Tip:
It is possible to set a value for this flag even when E-Invoicing is disabled. However, it comes into effect only when E-Invoicing is enabled.
Indicates that this resource has been deleted when the value is true\n.
Confirms that a customer is registered under GST. If set to true\nthen the Reverse Charge Mechanism\nis applicable. This field is applicable only when Australian GST is configured for your site.
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. This attribute is applicable only when Consolidated Invoicing is enabled.
Note:
Any invoices raised when a subscription activates from in_trial or future status, are not consolidated by default. Contact Support to enable consolidation for such invoices.
An overridden value for the first two characters of the full VAT number.\nOnly applicable specifically for customers with billing_address
country\nas XI\n(which is United Kingdom - Northern Ireland\n).
When you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, you have the option of setting billing_address
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\nXI\nby default. However, if the VAT number was registered in UK, the value should be GB.\nSet\nvat_number_prefix\nto GB\nfor such cases.
The Peppol BIS scheme associated with the 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\n.
Tip:
If there are additional entity identifiers for the customer not associated with the vat_number, they can be provided as the entity_identifiers[] array.
The standard used for specifying the entity_identifier_scheme.\nCurrently only iso6523-actorid-upis\nis supported and is used by default when not provided.
Tip:
If there are additional entity identifiers for the customer not associated with the vat_number, they can be provided as the entity_identifiers[] array.
The ISO 3166-2 state/province 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).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
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.
The unique id for the entity_identifier\nin Chargebee. When not provided, it is autogenerated.
The value of the entity_identifier.\nThis identifies the customer entity on the Peppol network. For example: 10101010-STO-10\n.
Tip:
If there is only one entity identifier for the customer and the value is the same as vat_number, then there is no need to provide the entity_identifiers[] array. See description for entity_identifiers[].
The Peppol BIS scheme associated with the 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\n.
Tip:
If there is only one entity identifier for the customer and the value is the same as vat_number, then there is no need to provide the entity_identifiers[] array. See description for entity_identifiers[].
The standard used for specifying the entity_identifier\nscheme.\nCurrently, only iso6523-actorid-upis\nis supported and is used by default when not provided.
Tip:
If there is only one entity identifier for the customer and the value is the same as vat_number, then there is no need to provide the entity_identifiers[] array. See description for entity_identifiers[].
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.
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.
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.
When the customer is part of an account hierarchy, this attribute defines the level of access that the parent account has to the customer's information.\nNote:\nthe 'parent' is the customer whose id is payment_owner_id.\nHowever, if the payment_owner_id\nis the customer itself, then the parent is parent_id\n.
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.
The time until which the download_url\nis valid.
The unique id for the e-invoice. This is auto-generated by Chargebee.
The status of processing the e-invoice. To obtain detailed information about the current status, see message.
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* success -The e-invoice has been successfully delivered to the customer.
\n* scheduled -Sending the e-invoice to the customer has been scheduled.
\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* 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.
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:
The ISO 3166-2 state/province 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).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
Action to be taken when the contract term completes.
\n* evergreen -Contract term completes and the subscription renews.
\n* renew_once -Used when you want to renew the contract term just once. Does the following: - Contract term completes and a new contract term is started for the number of billing cycles specified in contract_billing_cycle_on_renewal.
action_at_term_end for the new contract term is set to cancel.contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.Contract term completes and subscription is canceled.
", "enum" : [ "renew", "evergreen", "cancel", "renew_once" ], "example" : null }, "total_contract_value" : { "type" : "integer", "format" : "int64", "default" : 0, "deprecated" : false, "description" : "The sum of the totals\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.\nIf the subscription was imported\nwith the contract term, then this value includes the value passed for total_amount_raised\n.
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.
The number of days before 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.
The number of subscription billing cycles remaining after the current one for the contract term. This attribute is only returned for active\ncontract terms.
Applicable only when End-of-trial Action\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* site_default -The action configured for the site\nat the time when the trial ends, takes effect. This is the default value when trial_end_action\nis not\ndefined for the plan.
The action configured for the site\nat the time when the trial ends, takes effect. This is the default value when trial_end_action\nis defined for the plan.
The subscription cancels.
\n* activate_subscription -The subscription activates and charges are raised for non-metered items.
", "enum" : [ "site_default", "plan_default", "activate_subscription", "cancel_subscription" ], "example" : null }, "next_billing_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Date on which the next billing happens. This will be null for non-renewing and cancelled subscriptions.\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\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).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
Action to be taken when the contract term completes.
\n* evergreen -Contract term completes and the subscription renews.
\n* cancel -Contract term completes and subscription is canceled.
\n* renew_once -Used when you want to renew the contract term just once. Does the following: - Contract term completes and a new contract term is started for the number of billing cycles specified in contract_billing_cycle_on_renewal.
action_at_term_end for the new contract term is set to cancel.contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.The sum of the totals\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.\nIf the subscription was imported\nwith the contract term, then this value includes the value passed for total_amount_raised\n.
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.
The number of days before 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.
The number of subscription billing cycles remaining after the current one for the contract term. This attribute is only returned for active\ncontract terms.
The details of the line items in this invoice estimate.
\nNote
Line items that meet both the following conditions are not returned:
metered.line_item.amount is 0.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\nis enabled.
The decimal representation of the quantity of this line_item. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
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\nis enabled.
The reason due to which the line item price/amount is exempted from tax.
\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 -You are not registered for tax in the customer's region. This is also the reason code when both billing_address\nand shipping_address\nhave not been provided for the customer and subscription respectively
If the Customer is marked as Tax exempt
", "enum" : [ "tax_not_configured", "region_non_taxable", "export", "customer_exempt", "product_exempt", "zero_rated", "reverse_charge", "high_value_physical_goods", "zero_value_item", "tax_not_configured_external_provider" ], "example" : null }, "entity_id" : { "type" : "string", "deprecated" : false, "description" : "The identifier of the modelled entity this line item is based on. Will be null for 'adhoc' entity type\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.
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\nis enabled.
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\nis enabled.
The decimal representation of the quantity purchased from this tier. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
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\nis enabled.
The type of deduction and the amount to which it is applied.
\n* item_level_coupon -The deduction is due to a coupon applied to a line item of the invoice. The coupon id\nis available as entity_id\n.
The deduction is due to a coupon applied to the invoice sub_total.\nThe coupon id\nis available as entity_id\n.
The deduction is due to a legacy adjustment credit applied to the invoice. The entity_id\nis null\nin this case. The legacy credits feature is superseded by adjustment_credit_notes\n.
The deduction is due to a promotional credit\napplied to the invoice. The entity_id\nis null\nin this case.
The ISO 3166-2 state/province 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).
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.
The type of deduction and the amount to which it is applied.
\n* item_level_coupon -The deduction is due to a coupon applied to line item. The coupon id\nis passed as entity_id\n.
The deduction is due to a legacy adjustment credit applied to the invoice. The entity_id\nis null\nin this case. The legacy credits feature is superseded by adjustment_credit_notes\n.
The deduction is due to a coupon applied to the invoice sub_total.\nThe coupon id is passed as entity_id\n.
The deduction is due to a promotional credit\napplied to the invoice.
", "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.
The coupon code\n, if applicable, used to provide the discount. The coupon.id\nis available in entity_id\n.
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.
The details of the line items in this invoice estimate.
\nNote
Line items that meet both the following conditions are not returned:
metered.line_item.amount is 0.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\nis enabled.
The decimal representation of the quantity of this line_item. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
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\nis enabled.
The reason due to which the line item price/amount is exempted from tax.
\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 -You are not registered for tax in the customer's region. This is also the reason code when both billing_address\nand shipping_address\nhave not been provided for the customer and subscription respectively
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
", "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.
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\nis enabled.
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\nis enabled.
The decimal representation of the quantity purchased from this tier. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
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\nis enabled.
The type of deduction and the amount to which it is applied.
\n* promotional_credits -The deduction is due to a promotional credit\napplied to the invoice. The entity_id\nis null\nin this case.
The deduction is due to a coupon applied to a line item of the invoice. The coupon id\nis available as entity_id\n.
The deduction is due to a coupon applied to the invoice sub_total.\nThe coupon id\nis available as entity_id\n.
The deduction is due to a legacy adjustment credit applied to the invoice. The entity_id\nis null\nin this case. The legacy credits feature is superseded by adjustment_credit_notes\n.
The ISO 3166-2 state/province 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).
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.
The type of deduction and the amount to which it is applied.
\n* prorated_credits -The deduction is due to a legacy adjustment credit applied to the invoice. The entity_id\nis null\nin this case. The legacy credits feature is superseded by adjustment_credit_notes\n.
The deduction is due to a promotional credit\napplied to the invoice.
\n* item_level_coupon -The deduction is due to a coupon applied to line item. The coupon id\nis passed as entity_id\n.
The deduction is due to a coupon applied to the invoice sub_total.\nThe coupon id is passed as entity_id\n.
When the deduction is due to a coupon\n, then this is the id\nof the coupon.
The coupon code\n, if applicable, used to provide the discount. The coupon.id\nis available in entity_id\n.
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.
The identifier of the payment_schedule_scheme\n, used to create the payment schedules.
The details of the line items in this invoice estimate.
\nNote
Line items that meet both the following conditions are not returned:
metered.line_item.amount is 0.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\nis enabled.
The decimal representation of the quantity of this line_item. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
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\nis enabled.
The reason due to which the line item price/amount is exempted from tax.
\n* export -You are not registered for tax in the customer's region. This is also the reason code when both billing_address\nand shipping_address\nhave not been provided for the customer and subscription respectively
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
", "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.
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\nis enabled.
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\nis enabled.
The decimal representation of the quantity purchased from this tier. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
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\nis enabled.
The type of deduction and the amount to which it is applied.
\n* item_level_coupon -The deduction is due to a coupon applied to a line item of the invoice. The coupon id\nis available as entity_id\n.
The deduction is due to a coupon applied to the invoice sub_total.\nThe coupon id\nis available as entity_id\n.
The deduction is due to a legacy adjustment credit applied to the invoice. The entity_id\nis null\nin this case. The legacy credits feature is superseded by adjustment_credit_notes\n.
The deduction is due to a promotional credit\napplied to the invoice. The entity_id\nis null\nin this case.
The ISO 3166-2 state/province 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).
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.
The type of deduction and the amount to which it is applied.
\n* promotional_credits -The deduction is due to a promotional credit\napplied to the invoice.
\n* prorated_credits -The deduction is due to a legacy adjustment credit applied to the invoice. The entity_id\nis null\nin this case. The legacy credits feature is superseded by adjustment_credit_notes\n.
The deduction is due to a coupon applied to the invoice sub_total.\nThe coupon id is passed as entity_id\n.
The deduction is due to a coupon applied to line item. The coupon id\nis passed as entity_id\n.
When the deduction is due to a coupon\n, then this is the id\nof the coupon.
The coupon code\n, if applicable, used to provide the discount. The coupon.id\nis available in entity_id\n.
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.
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\nis enabled.
The decimal representation of the quantity of this line_item. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
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\nis enabled.
The reason due to which the line item price/amount is exempted from tax.
\n* export -You are not registered for tax in the customer's region. This is also the reason code when both billing_address\nand shipping_address\nhave not been provided for the customer and subscription respectively
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
", "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.
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\nis enabled.
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\nis enabled.
The decimal representation of the quantity purchased from this tier. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
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\nis enabled.
The type of deduction and the amount to which it is applied.
\n* prorated_credits -The deduction is due to a legacy adjustment credit applied to the invoice. The entity_id\nis null\nin this case. The legacy credits feature is superseded by adjustment_credit_notes\n.
The deduction is due to a coupon applied to a line item of the invoice. The coupon id\nis available as entity_id\n.
The deduction is due to a promotional credit\napplied to the invoice. The entity_id\nis null\nin this case.
The deduction is due to a coupon applied to the invoice sub_total.\nThe coupon id\nis available as entity_id\n.
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.
The type of deduction and the amount to which it is applied.
\n* document_level_coupon -The deduction is due to a coupon applied to the invoice sub_total.\nThe coupon id is passed as entity_id\n.
The deduction is due to a promotional credit\napplied to the invoice.
\n* prorated_credits -The deduction is due to a legacy adjustment credit applied to the invoice. The entity_id\nis null\nin this case. The legacy credits feature is superseded by adjustment_credit_notes\n.
The deduction is due to a coupon applied to line item. The coupon id\nis passed as entity_id\n.
When the deduction is due to a coupon\n, then this is the id\nof the coupon.
The coupon code\n, if applicable, used to provide the discount. The coupon.id\nis available in entity_id\n.
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.
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\nis enabled.
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.
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\nis enabled.
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\nis enabled.
The decimal representation of the quantity purchased from this tier. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
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\nis enabled.
Whenever any important changes happen in your Chargebee site, they are recorded as events. An event contains data about affected resources and additional details such as when the change occurred. For example, when a subscription is cancelled due to non payment, an event subscription_cancelled is recorded.
If webhooks have been configured 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. The webhook call is an HTTP POST with content type application/json.
Caution:\nWebhooks are asynchronous and are not recommended for time-critical applications. It is very much possible and even likely that webhooks reach your application out-of-order and that they get duplicated. For time-critical applications, we recommend using the List events API to poll Chargebee for events.
To mark a webhook notification successful, we expect the HTTP status code to be 2XX from your webhook URL. If we don't receive 2XX response code, we retry calling your webhook with a progressively increasing delay for the next 2 days. You could also resend 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 parameter since its value uniquely identifies an event.\nFor example, your application could do the following for each webhook notification:
id and keep it in a persistent store such as a relational database or redis.id is already processed.Webhooks can also arrive at your application out-of-order. This can be due to issues such as network delays or webhook failures. However, you can order the events by examining the resource_version attribute of the resource sent by the webhook. For every change made to the resource, resource_version is updated with a new timestamp in milliseconds.\nFor example, if you wish to sync resource changes from Chargebee to your application, you could:
resource_version attribute from the resource in the webhook.resource_version from the resource stored on your side.API Version\nChargebee supports multiple API versions now. The 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.
You can have basic authentication\nfor the webhook url.
In addition to securing your webhook, you can ensure the integrity of the event data by fetching it again using the Retrieve an Event\nAPI call.
Webhooks from Chargebee originate from a specific set of IP addresses.
The "user"" that triggered the event. The value depends on the source
source is admin_console: the email address of the user that triggered the event.source is api, js_api or bulk_operation: the name of the API key that was used to trigger the event.source is external_service: the name of the service that called our webhook. Eg. ADYEN, STRIPE, AMAZON_PAYMENTS etc.source is hosted_page or portal: the user attribute is not passed.The types of event provided by chargebee. Refer event types\nfor all the event types provided by us currently.
\n* card_deleted -Sent when a card is deleted for a customer
\n* rule_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 - \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 - \n* subscription_ramp_drafted - \n* rule_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 - \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 - \n* omnichannel_subscription_item_dunning_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 - \n* subscription_ramp_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 - \n* plan_deleted -Sent when a plan is deleted.
\n* omnichannel_subscription_imported - \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 - \n* record_purchase_failed - \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 - \n* unbilled_charges_created -Triggered when unbilled charges are created
\n* subscription_moved_in - \n* subscription_ramp_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* omnichannel_subscription_item_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* 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 - \n* subscription_moved_out - \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 - \n* transaction_created -Triggered when a transaction is recorded
\n* customer_deleted -Sent when a customer is deleted
\n* subscription_items_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 - \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 - \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 - \n* gift_claimed -Triggered when a gift is claimed
\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 - \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 - \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 - \n* omnichannel_subscription_item_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 - \n* omnichannel_subscription_item_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 - \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.
Sent when a plan is changed.
\n* tax_withheld_recorded -Triggered when a tax withheld is recorded for an invoice
\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 - \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 - \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 - \n* tax_withheld_deleted -Triggered when a tax withheld is deleted
\n* omnichannel_subscription_item_dunning_started - \n* sales_order_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 - \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 - \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
", "enum" : [ "plan_created", "plan_updated", "plan_deleted", "addon_created", "addon_updated", "addon_deleted", "coupon_created", "coupon_updated", "coupon_deleted", "coupon_set_created", "coupon_set_updated", "coupon_set_deleted", "coupon_codes_added", "coupon_codes_deleted", "coupon_codes_updated", "customer_created", "customer_changed", "customer_deleted", "customer_moved_out", "customer_moved_in", "promotional_credits_added", "promotional_credits_deducted", "subscription_created", "subscription_created_with_backdating", "subscription_started", "subscription_trial_end_reminder", "subscription_activated", "subscription_activated_with_backdating", "subscription_changed", "subscription_trial_extended", "mrr_updated", "subscription_changed_with_backdating", "subscription_cancellation_scheduled", "subscription_cancellation_reminder", "subscription_cancelled", "subscription_canceled_with_backdating", "subscription_reactivated", "subscription_reactivated_with_backdating", "subscription_renewed", "subscription_items_renewed", "subscription_scheduled_cancellation_removed", "subscription_changes_scheduled", "subscription_scheduled_changes_removed", "subscription_shipping_address_updated", "subscription_deleted", "subscription_paused", "subscription_pause_scheduled", "subscription_scheduled_pause_removed", "subscription_resumed", "subscription_resumption_scheduled", "subscription_scheduled_resumption_removed", "subscription_advance_invoice_schedule_added", "subscription_advance_invoice_schedule_updated", "subscription_advance_invoice_schedule_removed", "pending_invoice_created", "pending_invoice_updated", "invoice_generated", "invoice_generated_with_backdating", "invoice_updated", "invoice_deleted", "credit_note_created", "credit_note_created_with_backdating", "credit_note_updated", "credit_note_deleted", "subscription_renewal_reminder", "transaction_created", "transaction_updated", "transaction_deleted", "payment_succeeded", "payment_failed", "dunning_updated", "payment_refunded", "payment_initiated", "refund_initiated", "authorization_succeeded", "authorization_voided", "card_added", "card_updated", "card_expiry_reminder", "card_expired", "card_deleted", "payment_source_added", "payment_source_updated", "payment_source_deleted", "payment_source_expiring", "payment_source_expired", "payment_source_locally_deleted", "virtual_bank_account_added", "virtual_bank_account_updated", "virtual_bank_account_deleted", "token_created", "token_consumed", "token_expired", "unbilled_charges_created", "unbilled_charges_voided", "unbilled_charges_deleted", "unbilled_charges_invoiced", "order_created", "order_updated", "order_cancelled", "order_delivered", "order_returned", "order_ready_to_process", "order_ready_to_ship", "order_deleted", "order_resent", "quote_created", "quote_updated", "quote_deleted", "tax_withheld_recorded", "tax_withheld_deleted", "tax_withheld_refunded", "gift_scheduled", "gift_unclaimed", "gift_claimed", "gift_expired", "gift_cancelled", "gift_updated", "hierarchy_created", "hierarchy_deleted", "payment_intent_created", "payment_intent_updated", "contract_term_created", "contract_term_renewed", "contract_term_terminated", "contract_term_completed", "contract_term_cancelled", "voucher_created", "voucher_expired", "voucher_create_failed", "subscription_ramp_created", "subscription_ramp_deleted", "subscription_ramp_applied", "subscription_ramp_drafted", "subscription_ramp_updated", "subscription_moved_in", "subscription_moved_out", "subscription_movement_failed", "omnichannel_subscription_created", "omnichannel_subscription_item_renewed", "omnichannel_subscription_item_downgraded", "omnichannel_subscription_item_expired", "omnichannel_subscription_item_cancellation_scheduled", "omnichannel_subscription_item_scheduled_cancellation_removed", "omnichannel_subscription_item_resubscribed", "omnichannel_subscription_item_upgraded", "omnichannel_subscription_item_cancelled", "omnichannel_subscription_imported", "omnichannel_subscription_item_grace_period_started", "omnichannel_subscription_item_grace_period_expired", "omnichannel_subscription_item_dunning_started", "omnichannel_subscription_item_dunning_expired", "rule_created", "rule_updated", "rule_deleted", "record_purchase_failed", "omnichannel_subscription_item_change_scheduled", "omnichannel_subscription_item_scheduled_change_removed", "omnichannel_subscription_item_reactivated", "sales_order_created", "sales_order_updated", "omnichannel_subscription_item_changed", "omnichannel_subscription_item_paused", "omnichannel_subscription_item_resumed", "omnichannel_one_time_order_created", "omnichannel_one_time_order_item_cancelled", "omnichannel_subscription_item_pause_scheduled" ], "example" : null }, "api_version" : { "type" : "string", "default" : "v1", "deprecated" : false, "description" : "The Chargebee API Version used for rendering this event content. While processing webhooks, ensure this version is same as the API version used by your webhook server's client library.\n\\* v1 -\n\nChargebee API version V1\n\\* v2 -\n\nChargebee 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\\* , \\*invoice\\* etc) based on the \\[event type\\](/docs/api/v2/pcv-1/events/event-types). These resources are structured based on the Chargebee API version indicated by the \\*api_version\\* attribute.\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.
Note:\nApplicable only when event_source is api.
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.
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.Webhook call has been suspended after the all retries have resulted in failure.
\n* succeeded -Webhook call was successful.
\n* 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
", "enum" : [ "not_configured", "scheduled", "succeeded", "re_scheduled", "failed", "skipped", "not_applicable", "disabled", "rate_limited" ], "example" : null } }, "required" : [ "id", "webhook_status" ], "example" : null }, "example" : null } }, "required" : [ "content", "id", "occurred_at", "source" ], "example" : null }, "EventName" : { "type" : "string", "deprecated" : false, "enum" : [ "cancellation_page_loaded" ], "example" : null }, "EventType" : { "type" : "string", "deprecated" : false, "enum" : [ "plan_created", "plan_updated", "plan_deleted", "addon_created", "addon_updated", "addon_deleted", "coupon_created", "coupon_updated", "coupon_deleted", "coupon_set_created", "coupon_set_updated", "coupon_set_deleted", "coupon_codes_added", "coupon_codes_deleted", "coupon_codes_updated", "customer_created", "customer_changed", "customer_deleted", "customer_moved_out", "customer_moved_in", "promotional_credits_added", "promotional_credits_deducted", "subscription_created", "subscription_created_with_backdating", "subscription_started", "subscription_trial_end_reminder", "subscription_activated", "subscription_activated_with_backdating", "subscription_changed", "subscription_trial_extended", "mrr_updated", "subscription_changed_with_backdating", "subscription_cancellation_scheduled", "subscription_cancellation_reminder", "subscription_cancelled", "subscription_canceled_with_backdating", "subscription_reactivated", "subscription_reactivated_with_backdating", "subscription_renewed", "subscription_items_renewed", "subscription_scheduled_cancellation_removed", "subscription_changes_scheduled", "subscription_scheduled_changes_removed", "subscription_shipping_address_updated", "subscription_deleted", "subscription_paused", "subscription_pause_scheduled", "subscription_scheduled_pause_removed", "subscription_resumed", "subscription_resumption_scheduled", "subscription_scheduled_resumption_removed", "subscription_advance_invoice_schedule_added", "subscription_advance_invoice_schedule_updated", "subscription_advance_invoice_schedule_removed", "pending_invoice_created", "pending_invoice_updated", "invoice_generated", "invoice_generated_with_backdating", "invoice_updated", "invoice_deleted", "credit_note_created", "credit_note_created_with_backdating", "credit_note_updated", "credit_note_deleted", "subscription_renewal_reminder", "transaction_created", "transaction_updated", "transaction_deleted", "payment_succeeded", "payment_failed", "dunning_updated", "payment_refunded", "payment_initiated", "refund_initiated", "authorization_succeeded", "authorization_voided", "card_added", "card_updated", "card_expiry_reminder", "card_expired", "card_deleted", "payment_source_added", "payment_source_updated", "payment_source_deleted", "payment_source_expiring", "payment_source_expired", "payment_source_locally_deleted", "virtual_bank_account_added", "virtual_bank_account_updated", "virtual_bank_account_deleted", "token_created", "token_consumed", "token_expired", "unbilled_charges_created", "unbilled_charges_voided", "unbilled_charges_deleted", "unbilled_charges_invoiced", "order_created", "order_updated", "order_cancelled", "order_delivered", "order_returned", "order_ready_to_process", "order_ready_to_ship", "order_deleted", "order_resent", "quote_created", "quote_updated", "quote_deleted", "tax_withheld_recorded", "tax_withheld_deleted", "tax_withheld_refunded", "gift_scheduled", "gift_unclaimed", "gift_claimed", "gift_expired", "gift_cancelled", "gift_updated", "hierarchy_created", "hierarchy_deleted", "payment_intent_created", "payment_intent_updated", "contract_term_created", "contract_term_renewed", "contract_term_terminated", "contract_term_completed", "contract_term_cancelled", "voucher_created", "voucher_expired", "voucher_create_failed", "subscription_ramp_created", "subscription_ramp_deleted", "subscription_ramp_applied", "subscription_ramp_drafted", "subscription_ramp_updated", "subscription_moved_in", "subscription_moved_out", "subscription_movement_failed", "omnichannel_subscription_created", "omnichannel_subscription_item_renewed", "omnichannel_subscription_item_downgraded", "omnichannel_subscription_item_expired", "omnichannel_subscription_item_cancellation_scheduled", "omnichannel_subscription_item_scheduled_cancellation_removed", "omnichannel_subscription_item_resubscribed", "omnichannel_subscription_item_upgraded", "omnichannel_subscription_item_cancelled", "omnichannel_subscription_imported", "omnichannel_subscription_item_grace_period_started", "omnichannel_subscription_item_grace_period_expired", "omnichannel_subscription_item_dunning_started", "omnichannel_subscription_item_dunning_expired", "rule_created", "rule_updated", "rule_deleted", "record_purchase_failed", "omnichannel_subscription_item_change_scheduled", "omnichannel_subscription_item_scheduled_change_removed", "omnichannel_subscription_item_reactivated", "sales_order_created", "sales_order_updated", "omnichannel_subscription_item_changed", "omnichannel_subscription_item_paused", "omnichannel_subscription_item_resumed", "omnichannel_one_time_order_created", "omnichannel_one_time_order_item_cancelled", "omnichannel_subscription_item_pause_scheduled" ], "example" : null }, "ExcludeTaxType" : { "type" : "string", "default" : "none", "deprecated" : false, "enum" : [ "exclusive", "none" ], "example" : null }, "Export" : { "type" : "object", "description" : "Export resource represents an export job and contains the status of the job and the download URL, if the job is successfully completed.\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", "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\\* pdf -\n\nPDF\n\\* zip -\n\nZIP\n", "enum" : [ "pdf", "zip" ], "example" : null }, "status" : { "type" : "string", "default" : "in_process", "deprecated" : false, "description" : "Current status of the export operation\n\\* completed -\n\nCompleted\n\\* failed -\n\nFailed\n\\* in_process -\n\nIn 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.
The time until which the download_url\nis valid.
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.
When true\n, the claim happens automatically. When not passed, the default value in the site settings is used.
When true\n, indicates that the gift does not expire. Do not pass or pass as false\nwhen auto_claim\nis set.
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.
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.
When a customer belongs to an account hierarchy, 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.
Note
Related Endpoints
The id\nof the customer associated with this hierarchy\nresource.
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.
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.
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.
A list of id\ns representing the immediate children, if any exist, for the customer identified by customer_id\n.
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's query parameters. Using this ID, you can fetch the hosted page and perform actions related to the success of the marketing campaign.
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 of hosted page:
checkout_new, checkout_existing, and checkout_one_time, the URL expires 3 hours after the page is created.collect_now and manage_payment_sources, the URL expires 5 days after creation.Specifies the UI layout for the hosted page. The value is always in_app for this API version.
Applicable only when type is checkout_new, checkout_existing, checkout_one_time, manage_payment_sources, checkout_gift, or claim_gift.
The hosted page is rendered in the in-app layout.
\n* full_page -Not supported for this API version. Upgrade to the latest API version to use this layout.
", "enum" : [ "in_app", "full_page" ], "example" : null }, "content" : { "type" : "object", "additionalProperties" : true, "deprecated" : false, "description" : "This attribute will be returned only during retrieve hosted page API call and also the retrieved hosted page resource state should be either in \"succeeded\" or \"cancelled\" state. If hosted page state is \"succeeded\", then the subscription, customer, card \\\\\\& invoice(optional) resources during checkout can be obtained. If hosted page is state is \"cancelled\", then it will be empty i.e no information about checkout.\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.
The id\nof the subscription\nfor which the receipt was sent.
The id\nof the customer\nobject to which the subscription belongs.
The\nplan_id\nof the of the subscription.
The id\nof the invoice generated in Chargebee
The identifier of the subscription this invoice belongs to.\nNote:\nWhen consolidated invoicing is enabled, you have to refer to line_item`s\nsubscription_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.
Current status of this 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 -The invoice 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_invoicesattribute is set to true.\nThe invoice is yet to be closed (sent for payment collection). All invoices are generated with this status when Metered Billing is enabled for the site.
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.
", "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.
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[].amount
line_item_discounts[].discount_amount.The unpaid amount that is due on the invoice. This is calculated as: total
amount_paid\napplied_credits.applied_amountadjustment_credit_notes.cn_totallinked_taxes_withheld.amount.Payments collected successfully for the invoice. This is the sum of linked_payments[].txn_amount\nfor all linked_payments[]\nthat have txn_status\nas success.
The version number of this resource. For every change made to the resource, resource_version\nis updated with a new timestamp in milliseconds.
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.
Note:
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\none, then it is the sum of all line_items.amount\nbelonging to a new.
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.
Payments that are yet to be collected for the invoice. This is the same value as amount_due
linked_payments[].txn_amount\nfor all linked_payments[]\nthat have txn_status\nas in_progress.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.
An overridden value for the first two characters of the full VAT number.\nOnly applicable specifically for customers with billing_address
country\nas XI\n(which is United Kingdom - Northern Ireland\n).
When you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, you have the option of setting billing_address
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\nXI\nby default. However, if the VAT number was registered in UK, the value should be GB.\nSet\nvat_number_prefix\nto GB\nfor such cases.
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\nis enabled.
The decimal representation of the quantity of this line_item. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
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\nis enabled.
The reason due to which the line item price/amount is exempted from tax.
\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 -You are not registered for tax in the customer's region. This is also the reason code when both billing_address\nand shipping_address\nhave not been provided for the customer and subscription respectively
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.
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\nis enabled.
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\nis enabled.
The decimal representation of the quantity purchased from this tier. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
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\nis enabled.
The type of deduction and the amount to which it is applied.
\n* prorated_credits -The deduction is due to a legacy adjustment credit applied to the invoice. The entity_id\nis null\nin this case. The legacy credits feature is superseded by adjustment_credit_notes\n.
The deduction is due to a promotional credit\napplied to the invoice. The entity_id\nis null\nin this case.
The deduction is due to a coupon applied to the invoice sub_total.\nThe coupon id\nis available as entity_id\n.
The deduction is due to a coupon applied to a line item of the invoice. The coupon id\nis available as entity_id\n.
The ISO 3166-2 state/province 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).
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.
The type of deduction and the amount to which it is applied.
\n* prorated_credits -The deduction is due to a legacy adjustment credit applied to the invoice. The entity_id\nis null\nin this case. The legacy credits feature is superseded by adjustment_credit_notes\n.
The deduction is due to a promotional credit\napplied to the invoice.
\n* item_level_coupon -The deduction is due to a coupon applied to line item. The coupon id\nis passed as entity_id\n.
The deduction is due to a coupon applied to the invoice sub_total.\nThe coupon id is passed as entity_id\n.
When the deduction is due to a coupon\n, then this is the id\nof the coupon.
The coupon code\n, if applicable, used to provide the discount. The coupon.id\nis available in entity_id\n.
Details of tax_withheld\nagainst this invoice.
An auto-generated unique identifier for the tax withheld. The value starts with the prefix tax_wh_.\nFor example, tax_wh_16BdDXSlbu4uV1Ee6\n.
The status of this transaction.
\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 -Transaction is being processed by the gateway. This typically happens for direct debit transactions\nor, 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 -When connection with the Gateway gets terminated abruptly. For needs_attention\nstatus Chargebee automatically reconcile the transaction for few gateways, for rest of the gateways you have to use the Reconcile transaction API.\nYou can use this API to update the id_at_gateway\n(Gateway Transaction ID) and status\nfor a needs_attention\ntransaction to be reconciled at par with the gateway.
Learn more\nabout needs_attention\ntransaction status
The status of the transaction.
\n* timeout -The transaction failed because the gateway did not accept the connection.
\n* success -The transaction was successful.
\n* in_progress -The transaction is being processed by the gateway. This typically occurs for direct debit transactions\nor, for cards, refund transactions. Processing can take 2-7 days, depending on the gateway and payment method.
\n* needs_attention -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.\nUse this API to update the id_at_gateway\n(gateway transaction ID) and status.
Learn more\nabout needs_attention\ntransactions.
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 -The transaction failed. Refer to the error_code\nand error_text\nfields for details about the failure.
The type of transaction.
\n* authorization -The transaction is an authorization to capture the amount\nfrom the customer's payment_source\n.
The transaction is a refund that returns the amount\nto the customer's payment_source\n.
The transaction is a payment that captures the amount\nfrom the customer's payment_source\n.
The transaction is a reversal of a previously captured payment.
", "enum" : [ "authorization", "payment", "refund", "payment_reversal" ], "example" : null }, "amount_capturable" : { "type" : "integer", "format" : "int64", "default" : 0, "deprecated" : false, "description" : "This is the part of the authorized amount\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.
Type of reason for the authorization transaction.
\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 -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\n.
The status of this transaction.
\n* success -The transaction is successful.
\n* needs_attention -When connection with the Gateway gets terminated abruptly. For needs_attention\nstatus Chargebee automatically reconcile the transaction for few gateways, for rest of the gateways you have to use the Reconcile transaction API.\nYou can use this API to update the id_at_gateway\n(Gateway Transaction ID) and status\nfor a needs_attention\ntransaction to be reconciled at par with the gateway.
Learn more\nabout needs_attention\ntransaction status
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 -Transaction is being processed by the gateway. This typically happens for direct debit transactions\nor, 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.
", "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\\* chargebee -\n\nThe attempt was processed by Chargebee Recovery.\n\\* flexpay -\n\nThe attempt was processed by FlexPay Recovery.\n\\* successplus -\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\\* other -\n\nCan be set when none of the above reason codes are applicable\n\\* order_cancellation -\n\nOrder Cancellation\n\\* product_unsatisfactory -\n\nProduct Unsatisfactory\n\\* chargeback -\n\nCan be set when you are recording your customer Chargebacks\n\\* subscription_cancellation -\n\nThis reason will be set automatically for Credit Notes created during cancel subscription operation\n\\* fraudulent -\n\nFRAUDULENT\n\\* subscription_pause -\n\nThis reason will be automatically set to credit notes created during pause/resume subscription operation.\n\\* service_unsatisfactory -\n\nService Unsatisfactory\n\\* subscription_change -\n\nThis reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html)\nis enabled\n\\* write_off -\n\nThis reason will be set automatically for the Credit Notes created during invoice [Write Off](https://www.chargebee.com/docs/invoice-operations.html#write-off)\noperation.\n\\* order_change -\n\nOrder Change\n\\* waiver -\n\nWaiver\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\\* voided -\n\nWhen the Credit Note has been cancelled.\n\\* adjusted -\n\nWhen the Credit Note has been adjusted against an invoice.\n\\* refund_due -\n\nWhen the credits are yet to be used, or have been partially used.\n\\* refunded -\n\nWhen 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\\* pre_tax -\n\nCredits are applied before tax calculation.\n\\* post_tax -\n\nCredits 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\\* subscription_cancellation -\n\nThis reason will be set automatically for Credit Notes created during cancel subscription operation\n\\* waiver -\n\nWaiver\n\\* write_off -\n\nThis reason will be set automatically for the Credit Notes created during invoice [Write Off](https://www.chargebee.com/docs/invoice-operations.html#write-off)\noperation.\n\\* service_unsatisfactory -\n\nService Unsatisfactory\n\\* fraudulent -\n\nFRAUDULENT\n\\* product_unsatisfactory -\n\nProduct Unsatisfactory\n\\* order_change -\n\nOrder Change\n\\* subscription_change -\n\nThis reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html)\nis enabled\n\\* order_cancellation -\n\nOrder Cancellation\n\\* other -\n\nCan be set when none of the above reason codes are applicable\n\\* chargeback -\n\nCan be set when you are recording your customer Chargebacks\n\\* subscription_pause -\n\nThis 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\\* refunded -\n\nWhen the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded).\n\\* voided -\n\nWhen the Credit Note has been cancelled.\n\\* refund_due -\n\nWhen the credits are yet to be used, or have been partially used.\n\\* adjusted -\n\nWhen 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\\* fraudulent -\n\nFRAUDULENT\n\\* chargeback -\n\nCan be set when you are recording your customer Chargebacks\n\\* subscription_pause -\n\nThis reason will be automatically set to credit notes created during pause/resume subscription operation.\n\\* order_change -\n\nOrder Change\n\\* subscription_change -\n\nThis reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html)\nis enabled\n\\* product_unsatisfactory -\n\nProduct Unsatisfactory\n\\* write_off -\n\nThis reason will be set automatically for the Credit Notes created during invoice [Write Off](https://www.chargebee.com/docs/invoice-operations.html#write-off)\noperation.\n\\* subscription_cancellation -\n\nThis reason will be set automatically for Credit Notes created during cancel subscription operation\n\\* service_unsatisfactory -\n\nService Unsatisfactory\n\\* waiver -\n\nWaiver\n\\* order_cancellation -\n\nOrder Cancellation\n\\* other -\n\nCan 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\\* refund_due -\n\nWhen the credits are yet to be used, or have been partially used.\n\\* adjusted -\n\nWhen the Credit Note has been adjusted against an invoice.\n\\* voided -\n\nWhen the Credit Note has been cancelled.\n\\* refunded -\n\nWhen 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\\* awaiting_shipment -\n\nThe order has been picked up by an integration system, and synced to a shipping management platform\n\\* queued -\n\nOrder is yet to be processed by any system, these are scheduled orders created by Chargebee\n\\* returned -\n\nThe order has been returned after delivery.\n\\* complete -\n\nOrder has been processed successfully. Applicable only if you are using Chargebee's legacy order management system\n\\* processing -\n\nOrder is being processed. Applicable only if you are using Chargebee's legacy order management system\n\\* new -\n\nOrder has been created. Applicable only if you are using Chargebee's legacy order management system.\n\\* shipped -\n\nThe order has moved from order management system to a shipping system.\n\\* on_hold -\n\nThe order is paused from being processed.\n\\* cancelled -\n\nOrder has been cancelled. Applicable only if you are using Chargebee's legacy order management system\n\\* delivered -\n\nThe order has been delivered to the customer.\n\\* partially_delivered -\n\nThe order has been partially delivered to the customer.\n\\* voided -\n\nOrder 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\\* system_generated -\n\nThe order has been created by Chargebee automatically based on the preferences set by the user.\n\\* manual -\n\nThe 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\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:
invoice_note parameter for various endpoints in the API that also create invoices. For example, creating a subscription, creating an invoice, and closing a pending invoice.The ISO 3166-2 state/province 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).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The ISO 3166-2 state/province 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).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The unique id\nfor the e-invoice. This is auto-generated by Chargebee.
The status of processing the e-invoice. To obtain detailed information about the current status\n, see message\n.
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 -The e-invoice was not sent. This could be due to missing information or because the entity_identifier\nis not registered on the e-invoicing network.
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.
", "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:
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.
When not provided for feature.type\nquantity\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.
The value denoting the entitlement level granted.
\ntype 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".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.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.This attribute represents the order of the entitlement levels from lowest to highest.
\ntype 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.type is range: This attribute is 0 for the minimum value and 1 for the maximum value in the range.When not defined, it is assumed as the index of the levels[]\narray.
When type\nis quantity\nor range\n, this attribute indicates whether the entitlement level corresponds to unlimited units of the feature. Possible values:
true: The entitlement level corresponds to unlimited units of the feature. levels[].value is ignored for this level. This can only be set for the level that has the highest value for levels[].level.false: The entitlement level does not correspond to unlimited units of the feature.The id of the non-recurring add-on.
Offer fulfillment allows you to initiate, update, and retrieve the lifecycle of an offer fulfillment, after a personalized offer has been accepted. Whether the personalized offer triggers a direct billing change, a hosted checkout flow, or a redirect-based workflow, these APIs track acceptance, execution status, and completion, providing a consistent interface for fulfillment tracking and notifications.
Features of this object:
in_progress, completed, failed).Current status of the offer fulfillment process.
\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 -The offer fulfillment failed. The error object\nfield will be present to provide more details in this case.
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.
The ISO 3166-2 state/province 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).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The ISO 3166-2 state/province 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).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
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.
All payment_intents with status as inited, in_progress or authorized become expired after an hour automatically.
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.
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.
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.
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.
Error code received from the payment gateway when the payment_attempt\nfails.
List of payment attempts associated with this PaymentIntent. Each item in the list is a payment_attempt\nobject, identical in structure to active_payment_attempt\n.
Current status of the payment attempt.
\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 -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\nor failure_url\n.
Payment attempt is initialized.
\n* authorized -3DS verification successfully completed.
\n* pending_authorization -Waiting for the authorization.
\n* refused -3DS verification attempt failed.
", "enum" : [ "inited", "requires_identification", "requires_challenge", "requires_redirection", "authorized", "refused", "pending_authorization" ], "example" : null }, "payment_method_type" : { "type" : "string", "default" : "card", "deprecated" : false, "description" : "The payment method of this attempt.\n\\* swish -\n\nPayments made via Swish\n\\* stablecoin -\n\nPayments made via Stablecoin.\n\\* revolut_pay -\n\nPayments made via Revolut Pay.\n\\* alipay -\n\nPayments made via Alipay.\n\\* sofort -\n\nsofort\n\\* giropay -\n\ngiropay\n\\* electronic_payment_standard -\n\nElectronic Payment Standard\n\\* paypay - \\* boleto -\n\nboleto\n\\* kakao_pay -\n\nPayments made via Kakao Pay.\n\\* pix -\n\nPix\n\\* kbc_payment_button -\n\nKBC Payment Button\n\\* faster_payments -\n\nFaster Payments\n\\* paypal_express_checkout -\n\npaypal_express_checkout\n\\* go_pay -\n\nPayments made via GoPay\n\\* pay_by_bank -\n\nPay By Bank\n\\* klarna -\n\nPayments made via Klarna.\n\\* after_pay -\n\nPayments made via Afterpay\n\\* bancontact -\n\nbancontact\n\\* trustly -\n\nTrustly\n\\* wechat_pay -\n\nPayments made via WeChat Pay.\n\\* twint -\n\nPayments made via Twint\n\\* upi -\n\nupi\n\\* cash_app_pay -\n\nPayments made via Cash App Pay.\n\\* direct_debit -\n\ndirect_debit\n\\* netbanking_emandates -\n\nnetbanking_emandates\n\\* amazon_payments -\n\namazon_payments\n\\* sepa_instant_transfer -\n\nSEPA Instant Transfer\n\\* klarna_pay_now -\n\nKlarna Pay Now\n\\* online_banking_poland - \\* dotpay -\n\ndotpay\n\\* google_pay -\n\ngoogle_pay\n\\* payconiq_by_bancontact -\n\nPayments made via Payconiq by Bancontact.\n\\* payme -\n\nPayments made via PayMe\n\\* card -\n\ncard\n\\* naver_pay -\n\nPayments made via Naver Pay.\n\\* alipay_hk - \\* south_korean_cards - \\* ideal -\n\nideal\n\\* grab_pay -\n\nPayments made via GrabPay\n\\* pay_co -\n\nPayments made via PayCo\n\\* venmo -\n\nVenmo\n\\* gcash - \\* apple_pay -\n\napple_pay\n\\* pay_to -\n\nPayTo\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" ], "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 } }, "required" : [ "created_at", "modified_at", "status" ], "example" : null }, "example" : null }, "payment_intent_metadata" : { "type" : "object", "deprecated" : false, "properties" : { "source" : { "type" : "string", "deprecated" : false, "description" : "null\n", "enum" : [ "cb_js", "components_fields", "checkout_v3", "paynow_v3", "portal_v3", "gift_v3", "checkout_v4", "payment_component", "pc_inapp_v4", "pc_fpc_v4" ], "example" : null }, "client_ip_address" : { "type" : "string", "deprecated" : false, "maxLength" : 50, "example" : null }, "user_agent" : { "type" : "string", "deprecated" : false, "maxLength" : 1000, "example" : null }, "created_at" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "example" : null } }, "required" : [ "source" ], "example" : null } }, "required" : [ "amount", "created_at", "customer_id", "expires_at", "id", "modified_at", "status" ], "example" : null }, "PaymentIntentCreatedEvent" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The ID of the event\n", "example" : null }, "occurred_at" : { "type" : "integer", "format" : "int64", "description" : "Timestamp of the event\n", "example" : null }, "source" : { "type" : "string", "description" : "Source of the event\n", "example" : null }, "object" : { "type" : "string", "description" : "The object of the event\n", "example" : null }, "api_version" : { "type" : "string", "description" : "API version\n", "example" : null }, "event_type" : { "type" : "string", "description" : "Type of the event\n", "example" : null }, "webhook_status" : { "type" : "string", "description" : "Status of webhook\n", "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\n", "example" : null }, "occurred_at" : { "type" : "integer", "format" : "int64", "description" : "Timestamp of the event\n", "example" : null }, "source" : { "type" : "string", "description" : "Source of the event\n", "example" : null }, "object" : { "type" : "string", "description" : "The object of the event\n", "example" : null }, "api_version" : { "type" : "string", "description" : "API version\n", "example" : null }, "event_type" : { "type" : "string", "description" : "Type of the event\n", "example" : null }, "webhook_status" : { "type" : "string", "description" : "Status of webhook\n", "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", "dana", "touch_n_go", "tamara", "qpay", "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" ], "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" ], "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.
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.
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.
", "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.
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.
The identifier of the payment_schedule_scheme\n, used to create the payment schedules.
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.
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.
The ISO 3166-2 state/province 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).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The ISO 3166-2 state/province 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).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The gateway through which this payment voucher was created.\nNote:\nNote: Currently, stripe\nis the only supported gateway through which you can create the payment voucher.
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 -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.
\nThis feature is a Private Beta Release. Request access to enable the J.P. Morgan Mobility Payment Solutions gateway via payFURL for your test and live sites.
2Checkout is a payment gateway.
\n* first_data_global -First Data Global Gateway Virtual Terminal Account
\n* payway - \n* moyasar - \n* exact -Exact Payments is a payment gateway.
\n* deutsche_bank -Deutsche Bank is the leading German bank with strong European roots and a global network.
\nThis feature is a Private Beta Release.
BluePay is a payment gateway.
\n* paypal_express_checkout -PayPal Express Checkout is a payment gateway.
\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.
\nThis feature is a Private Beta Release. Request access to enable Nuvei for your test and live sites.
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* 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 -Paystack is a payment gateway for businesses in Africa. It enables secure payment acceptance both online and offline.
\nThis feature is a Private Beta Release. Request access to enable Paystack for your test and live sites.
Ezidebit is a payment gateway integration based in Australia that supports automated direct debit, BPAY, and card payments for businesses.
\nThis feature is a Private Beta Release.
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 - \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 -Solidgate is a secure and reliable payment processing solution that allows you to accept payments from customers and suitable for various types of businesses.
\nThis feature is a Private Beta Release.
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", "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.
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.\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:
Acquire: Incentivize trial users or prospects to subscribe.Expand: Encourage existing subscribers to purchase higher-value products or add-ons.Retain: Engage at-risk subscribers with targeted winbacks or discounts.Note: Growth solutions are currently in Early Access and available only for Chargebee Billing customers at no additional cost during the EAP period. This API is also part of the Early Access Program (EAP). To request access, go to the Chargebee Growth Early Access page in Chargebee Billing.
Features of this object
The Personalized Offers object enables you to:
Used exclusively with the following accounting integrations
\n: . For example:Location: Singapore.::...: : .... For example: Services : Plan.Used exclusively with the following accounting integrations
\n: .... For example, Region: South::.... For example: Location: North America: Canada: : .... For example: NA:US:CAUsed exclusively with the following accounting integrations
\n: : .... For example: Production: Assembly.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.
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\nis enabled.
Whether the plan.description\nshould be shown on invoice PDFs.\nIf this Boolean is changed, only invoices generated (or regenerated\n)after the change are affected; past invoices are not.
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\n.
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\nis enabled.
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\nis enabled.
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\nis enabled.
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
Represents a platform account in Chargebee.\nEach platform account includes a unique id and can optionally include partner_name and partner_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.
Note: You can instead allow your customers to access the portal via login page provided by Chargebee. Read more.
Please follow the below steps for supporting portal access via SSO:
{your_website_url}/portal_link).Notes about access URL:
Note: This feature is not supported in in-app 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.\nWorkflow:\nUsers should be redirected to the portal login URL - https://yourdomain.chargebeeportal.com/portal/login by passing the following parameters:
Upon successful authentication, a session is created for the user and Chargebee redirects the user to the return_url along with the following parameters:
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.
An overridden value for the first two characters of the full VAT number.\nOnly applicable specifically for customers with billing_address
country\nas XI\n(which is United Kingdom - Northern Ireland\n).
When you have enabled EU VAT\nin 2021 or have manually enabled\nthe Brexit configuration, you have the option of setting billing_address
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\nXI\nby default. However, if the VAT number was registered in UK, the value should be GB.\nSet\nvat_number_prefix\nto GB\nfor such cases.
Specifies the contract term's end date. It indicates when the action set in action_at_term_end\ngets triggered.
Indicates that this resource has been deleted when the value is true\n.
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\nis enabled.
The decimal representation of the quantity of this line_item. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
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\nis enabled.
The reason due to which the line item price/amount is exempted from tax.
\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 - \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 -You are not registered for tax in the customer's region. This is also the reason code when both billing_address\nand shipping_address\nhave not been provided for the customer and subscription respectively
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.
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\nis enabled.
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\nis enabled.
The decimal representation of the quantity purchased from this tier. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
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\nis enabled.
The type of deduction and the amount to which it is applied.
\n* item_level_coupon -The deduction is due to a coupon applied to a line item of the invoice. The coupon id\nis available as entity_id\n.
The deduction is due to a legacy adjustment credit applied to the invoice. The entity_id\nis null\nin this case. The legacy credits feature is superseded by adjustment_credit_notes\n.
The deduction is due to a coupon applied to the invoice sub_total.\nThe coupon id\nis available as entity_id\n.
The deduction is due to a promotional credit\napplied to the invoice. The entity_id\nis null\nin this case.
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.
The type of deduction and the amount to which it is applied.
\n* document_level_coupon -The deduction is due to a coupon applied to the invoice sub_total.\nThe coupon id is passed as entity_id\n.
The deduction is due to a legacy adjustment credit applied to the invoice. The entity_id\nis null\nin this case. The legacy credits feature is superseded by adjustment_credit_notes\n.
The deduction is due to a coupon applied to line item. The coupon id\nis passed as entity_id\n.
The deduction is due to a promotional credit\napplied to the invoice.
", "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.
The coupon code\n, if applicable, used to provide the discount. The coupon.id\nis available in entity_id\n.
The ISO 3166-2 state/province 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).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
The ISO 3166-2 state/province 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).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
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\nis enabled.
The decimal representation of the quantity of this line_item. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
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\nis enabled.
The reason due to which the line item price/amount is exempted from tax.
\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 -You are not registered for tax in the customer's region. This is also the reason code when both billing_address\nand shipping_address\nhave not been provided for the customer and subscription respectively
The type of deduction and the amount to which it is applied.
\n* item_level_coupon -The deduction is due to a coupon applied to a line item of the invoice. The coupon id\nis available as entity_id\n.
The deduction is due to a legacy adjustment credit applied to the invoice. The entity_id\nis null\nin this case. The legacy credits feature is superseded by adjustment_credit_notes\n.
The deduction is due to a coupon applied to the invoice sub_total.\nThe coupon id\nis available as entity_id\n.
The deduction is due to a discount\napplied to the invoice sub_total.\nThe discount id\nis available as the entity_id.
The deduction is due to a discount\napplied to a line item of the invoice. The discount id\nis available as the entity_id.
The deduction is due to a promotional credit\napplied to the invoice. The entity_id\nis null\nin this case.
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.
The type of deduction and the amount to which it is applied.
\n* document_level_coupon -The deduction is due to a coupon applied to the invoice sub_total.\nThe coupon id is passed as entity_id\n.
The deduction is due to a legacy adjustment credit applied to the invoice. The entity_id\nis null\nin this case. The legacy credits feature is superseded by adjustment_credit_notes\n.
The deduction is due to a coupon applied to line item. The coupon id\nis passed as entity_id\n.
The deduction is due to a discount\napplied to a line item of the invoice. The discount id\nis available as the entity_id.
The deduction is due to a promotional credit\napplied to the invoice.
\n* document_level_discount -The deduction is due to a discount\napplied to the invoice sub_total.\nThe discount id\nis available as the entity_id.
When the deduction is due to a\ncoupon\n, then this is the\nid\nof the coupon.
The coupon code\n, if applicable, used to provide the discount. The coupon.id\nis available in entity_id\n.
When the\noperation_type\nof a\nquote\nis\nonetime_invoice\n, the\nquoted_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.
Specifies the service period of the charge in days. When the quote is converted, the invoice.line_item.date_from\nis set to current date/time and invoice.line_item.date_to\nis set to service_period_in_days\nahead of date_from\n.
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
The price or per-unit-price of the addon. The value depends on the type of currency.
\nNote:
For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:
unit_price provided is $10The 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.
\nNote:
For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:
unit_price_in_decimal provided is $10.75Specifies the service period of the addon in days. When the quote is converted, the invoice.line_item.date_from\nis set to current date/time and invoice.line_item.date_to\nis set to service_period\ndays ahead of date_from\n.
When a quote 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.
Applicable only when operation_type\nof the quote is create_subscription_for_customer.\nFor subscriptions in the future\nstatus\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:
start_date cannot be earlier than 14th February.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:
Backdating must be enabled for subscription change operations.
\nOnly the following changes can be backdated:
\nChanges in the recurring items or their prices.
\nAddition of non-recurring items.
\nSubscription status is active, cancelled, or non_renewing.
The current day of the month does not exceed the limit set in Chargebee for backdating subscription change. This limit is the day of the month by which the accounting for the previous month must be closed.
\nThe date is on or after current_term_start.
The date is on or after the last date/time any of the following changes were made:
\nChanges in the recurring items or their prices.
\nAddition of non-recurring items.
\nThe 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.
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.
The change is scheduled to be carried out at the end of the billing cycle of the subscription.
\n* specific_date -The change is carried out as of changes_scheduled_at\n.
The change is carried out immediately upon quote conversion.
", "enum" : [ "end_of_term", "specific_date", "immediately" ], "example" : null }, "free_period" : { "type" : "integer", "format" : "int32", "deprecated" : false, "minimum" : 1, "example" : null }, "free_period_unit" : { "type" : "string", "deprecated" : false, "description" : "null\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\n.
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
The price or per-unit-price of the addon. The value depends on the type of currency.
\nNote:
For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:
unit_price provided is $10The 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\n)
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.
\nNote:
For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:
unit_price_in_decimal provided is $10.75Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
Action to be taken when the contract term completes.
\n* renew -contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.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.
action_at_term_end for the new contract term is set to cancel.Contract term completes and subscription is canceled.
\n* evergreen -Contract term completes and the subscription renews.
", "enum" : [ "renew", "evergreen", "cancel", "renew_once" ], "example" : null }, "total_contract_value" : { "type" : "integer", "format" : "int64", "default" : 0, "deprecated" : false, "description" : "The sum of the totals\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.\nIf the subscription was imported\nwith the contract term, then this value includes the value passed for total_amount_raised\n.
The number of days before 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.
The type\nof the item
Charge
\n* plan -Plan
\n* addon -Addon
", "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\n", "example" : null }, "occurred_at" : { "type" : "integer", "format" : "int64", "description" : "Timestamp of the event\n", "example" : null }, "source" : { "type" : "string", "description" : "Source of the event\n", "example" : null }, "object" : { "type" : "string", "description" : "The object of the event\n", "example" : null }, "api_version" : { "type" : "string", "description" : "API version\n", "example" : null }, "event_type" : { "type" : "string", "description" : "Type of the event\n", "example" : null }, "webhook_status" : { "type" : "string", "description" : "Status of webhook\n", "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\\* customer -\n\nEntity 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\\* failed -\n\nFailed\n\\* succeeded -\n\nSucceeded\n\\* scheduled -\n\nScheduled\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\n", "example" : null }, "occurred_at" : { "type" : "integer", "format" : "int64", "description" : "Timestamp of the event\n", "example" : null }, "source" : { "type" : "string", "description" : "Source of the event\n", "example" : null }, "object" : { "type" : "string", "description" : "The object of the event\n", "example" : null }, "api_version" : { "type" : "string", "description" : "API version\n", "example" : null }, "event_type" : { "type" : "string", "description" : "Type of the event\n", "example" : null }, "webhook_status" : { "type" : "string", "description" : "Status of webhook\n", "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\n", "example" : null }, "occurred_at" : { "type" : "integer", "format" : "int64", "description" : "Timestamp of the event\n", "example" : null }, "source" : { "type" : "string", "description" : "Source of the event\n", "example" : null }, "object" : { "type" : "string", "description" : "The object of the event\n", "example" : null }, "api_version" : { "type" : "string", "description" : "API version\n", "example" : null }, "event_type" : { "type" : "string", "description" : "Type of the event\n", "example" : null }, "webhook_status" : { "type" : "string", "description" : "Status of webhook\n", "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\n", "example" : null }, "occurred_at" : { "type" : "integer", "format" : "int64", "description" : "Timestamp of the event\n", "example" : null }, "source" : { "type" : "string", "description" : "Source of the event\n", "example" : null }, "object" : { "type" : "string", "description" : "The object of the event\n", "example" : null }, "api_version" : { "type" : "string", "description" : "API version\n", "example" : null }, "event_type" : { "type" : "string", "description" : "Type of the event\n", "example" : null }, "webhook_status" : { "type" : "string", "description" : "Status of webhook\n", "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 }, "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.
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.
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.
Subscriptions are invoiced at the start of every term based on the recurring items and charged immediately against the customer's credit card if 'auto_collection' is turned 'on', otherwise the resulting invoice will be created as 'Payment Due'.
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.
| Field ID | Field Value | APIs |
|---|---|---|
locationCode | Merchant to configure it on Avalara Platform under company locations | APIs having Item Prices attributes. |
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
| Field ID | Field Value | APIs |
|---|---|---|
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. |
Vertex: Chargebee shares field IDs and corresponding values with merchants, who then configure them on the Vertex Platform for seamless integration
Note:\nField Id like customerCode\n, customerClass\n, andtaxExempted\nbelong to the customer object.
Field Id like productCode\n, productClass\n, productTaxCode\n, and productClass\nbelong to the product object.
| Field ID | Field Value | APIs |
|---|---|---|
productCode | Merchant to configure it on Vertex Platform | APIs having Plan(PC1), Addons(PC1) and Item Prices(PC2) attributes. |
productClass | ||
customerCode | APIs involving customer attributes. Also includes APIs where we are creating new customers. For example: estimate, subscription, hosted pages. | |
customerClass |
Taxamo: Chargebee shares field IDs and corresponding values with merchants, who then configure them on the Taxamo Platform for seamless integration
| Field Id | Field Value | APIs |
|---|---|---|
productTaxCode | Merchant to configure it on Taxamo Platform | APIs having Plan(PC1), Addons(PC1) and Item Prices (PC2) attributes. |
productClass | ||
taxExempted | APIs involving customer attributes. Also includes APIs where we are creating new customers. For example: estimate, subscription, hosted pages. |
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.
| Field ID | Field Value | APIs |
|---|---|---|
indiaSez | SEZ_IGST_TAX | APIs involving customer attributes. Also includes APIs where we are creating new customers. For example: estimate, subscription, hosted pages. |
SEZ_ZERO_RATED_TAX | ||
indiaExport | EXPORT_IGST_TAX | |
EXPORT_ZERO_RATED_TAX |
All: For tax inclusive tax calculation, For tax exclusive tax calculation. This is currently used for price type overriding at customer level
| Field ID | Field Value | APIs |
|---|---|---|
priceType | TAX_INCLUSIVE | APIs involving customer attributes. Also includes APIs where we are creating new customers. For example: estimate, subscription, hosted pages. |
TAX_EXCLUSIVE | ||
SITE_DEFAULT | Removes price type override, and allows site level configuration to be used for tax calculation. |
Note:\nMake sure you choose the correct Field ID\nand Available APIs\ncombination from the table above.\nAll Product Catalog APIs include Plans\n, Addons\n, Coupons\n, Coupon Sets\n, Coupon Codes\n.
Current state of the subscription
\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 transferred\nstatus will be reflected on the source business entity's subscription attribute once the customer transfer\nactivity is completed successfully. This status is only valid for product catalog 2.0\nas the Multiple Business Entity features can only be enabled for product catalog 2.0.
The subscription is in trial.
\n* paused -The subscription is paused.\nThe subscription will not renew while in this state.
", "enum" : [ "future", "in_trial", "active", "non_renewing", "paused", "cancelled", "transferred" ], "example" : null }, "trial_start" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Start of the trial period for the subscription. Presence of this value for future\nsubscription implies the subscription will go into in_trial\nstate when it starts.
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.
Time at which the subscription was started. Is null\nfor future\nsubscriptions as it is yet to be started.
Time at which the subscription status\nlast changed to\nactive.\nFor example, this value is updated when an in_trial\nor\ncancelled\nsubscription activates.
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\n.
If true\n, ignores the hierarchy relationship\nand uses customer as payment and invoice owner.
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.
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.
If true\n, there are subscription changes scheduled on next renewal.
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.
Total number of invoices that are due for payment against the subscription.\nNote:\nNot supported if consolidated invoicing\nis enabled, or when the subscription is for the customer who is in hierarchy\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.
Total invoice due amount for this subscription. The value depends on the type of currency\n.\nNote:\nNot supported if consolidated invoicing\nis enabled, or when the subscription is for the customer who is in hierarchy\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.
Indicates that the subscription has been deleted when the value is true.\nYou can retrieve a deleted subscription using the list operation\n.
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/update subscription operations. This is useful in the following scenarios:
Set to false\nto override for this subscription, the site-level setting\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\n.
Quantity of the addon. Applicable for addons with pricing_model\nother than flat_fee\n.
The price or per-unit-price of the addon. The value depends on the type of currency.
\nNote:
For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:
unit_price provided is $10The 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\n)
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.
\nNote:
For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:
unit_price_in_decimal provided is $10.75Specifies how to manage charges or credits for the addon during a subscription update.
\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.
\nSee also:\naddons[proration_type]\nparameter for Update a subscription API\n.
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.
", "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.
The date till when the coupon can be applied. Applicable for limited_period\ncoupons\nonly.
The ISO 3166-2 state/province 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).
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code\n.
\nNote:\nIf you enter an invalid country code, the system will return an error.
\nBrexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom - Northern Ireland) is available as an option.
Action to be taken when the contract term completes.
\n* renew_once -Used when you want to renew the contract term just once. Does the following: - Contract term completes and a new contract term is started for the number of billing cycles specified in contract_billing_cycle_on_renewal.
action_at_term_end for the new contract term is set to cancel.Contract term completes and subscription is canceled.
\n* evergreen -Contract term completes and the subscription renews.
\n* renew -contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.The sum of the totals\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.\nIf the subscription was imported\nwith the contract term, then this value includes the value passed for total_amount_raised\n.
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.
The number of days before 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.
The number of subscription billing cycles remaining after the current one for the contract term. This attribute is only returned for active\ncontract terms.
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.
Note:
linked_taxes_withheld sub-resource under invoices.linked_tax_withheld_refunds sub-resource under credit_notes.An auto-generated unique identifier for the tax withheld. The value starts with the prefix tax_wh_.\nFor example, tax_wh_16BdDXSlbu4uV1Ee6\n.
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\nand hosted pages\n.
The status of the item price.
\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 -Indicates that the item price has been deleted. The id\nand name\ncan be reused.
The name of the item price used in customer-facing pages and documents. These include invoices\nand hosted pages.\nIf not provided, then name\nis used
The pricing scheme for this item price. If subscriptions, invoices or differential prices exist for this item price, pricing_model cannot be changed.
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.
", "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\n.
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\nis enabled.
type is plan: The billing period of the plan in period_units. For example, create a 6 month plan by providing period as 6 and period_unit as month.type is addon: The period of the addon in period_units. 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.If subscriptions or invoices exist for this item price, period\ncannot be changed. The period\nis mandatory when the item type\nis plan\nor addon
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
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.
", "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\n; contact Support\nto enable that feature.
The unit of time for trial_period\n.
A period of 1 calendar month.
\n* day -A period of 24 hours.
", "enum" : [ "day", "month" ], "example" : null }, "trial_end_action" : { "type" : "string", "deprecated" : false, "description" : "Applicable only when End-of-trial Action\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\n.
The subscription cancels.
\n* activate_subscription -The subscription activates and charges are raised for non-metered items.
\n* site_default -The action configured for the site\nat the time when the trial ends, takes effect.
", "enum" : [ "site_default", "activate_subscription", "cancel_subscription" ], "example" : null }, "shipping_period" : { "type" : "integer", "format" : "int32", "deprecated" : false, "description" : "Defines the shipping frequency. Example: to bill customer every 2 weeks, provide \"2\" here.\n", "minimum" : 1, "example" : null }, "shipping_period_unit" : { "type" : "string", "deprecated" : false, "description" : "Defines the shipping frequency in association with shipping period.\n\\* year -\n\nA period of 1 calendar year.\n\\* day -\n\nA period of 24 hours.\n\\* week -\n\nA period of 7 days.\n\\* month -\n\nA 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 for a subscription.\nAddons can also have billing cycles. However, you must contact Support to enable that. Also, for addons, you can override this while attaching it to a plan. However, if you provide the value while applying the addon to a subscription, then that value takes still higher precedence.\nIf subscriptions, invoices or differential prices\nexist for this item price, billing_cycles\ncannot be changed.
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.
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.
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\nor Update an attached item\nAPI.
\n* all -all addon-items and charge-items are applicable to this plan-item.
\n* restricted -only the addon-items or charge-items provided in applicable_items\ncan be applied to this plan-item.
Used exclusively with the following accounting integrations
\n: . For example:Location: Singapore.::...: : .... For example: Services : Plan.Used exclusively with the following accounting integrations
\n: .... For example, Region: South::.... For example: Location: North America: Canada: : .... For example: NA:US:CAUsed exclusively with the following accounting integrations
\n: : .... For example: Production: Assembly.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.
The payment method of this transaction
\n* naver_pay -Payments made via Naver Pay.
\n\n* unionpay -Unionpay
\n* paypay - \n* online_banking_poland -Online Banking Poland
\n\n* upi -upi
\n* payconiq_by_bancontact -Payments made via Payconiq by Bancontact.
\n\n* kakao_pay -Payments made via Kakao Pay.
\n\n* check -Check
\n* payme -Payments made via PayMe
\n\n* cash_app_pay -Payments made via Cash App Pay.
\n\n* custom -Custom
\n* amazon_payments -Amazon Payments
\n* boleto -boleto
\n* klarna -Payments made via Klarna.
\n\n* direct_debit -Direct Debit
\n* klarna_pay_now -Klarna Pay Now
\n\n* sepa_instant_transfer -Sepa Instant Transfer
\n\n* apple_pay -Apple Pay
\n* wechat_pay -Payments made via WeChat Pay.
\n\n* twint -Payments made via Twint
\n\n* kbc_payment_button -KBC Payment Button
\n* bancontact -Bancontact
\n* faster_payments -Faster Payments
\n\n* go_pay -Payments made via GoPay
\n\n* stablecoin -Payments made via Stablecoin.
\n\n* venmo -Venmo
\n\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* trustly -Trustly
\n* ach_credit -ACH Credit
\n* sepa_credit -SEPA Credit
\n* alipay_hk - \n* card -Card
\n* ideal -IDEAL
\n* gcash - \n* chargeback -Only applicable for a transaction of type\n= refund.\nThis value is set by Chargebee when an automated chargeback\noccurs. You can also set this explicitly when recording a refund\n.
Automated Bank Transfer
\n\n* google_pay -Google Pay
\n* netbanking_emandates -netbanking_emandates
\n* pay_to -PayTo
\n\n* pay_by_bank -Pay By Bank
\n* dotpay -Dotpay
\n* alipay -Payments made via Alipay.
\n\n* sofort -Sofort
\n* swish -Payments made via Swish
\n\n* grab_pay -Payments made via GrabPay
\n\n* pix -Pix
\n\n* giropay -giropay
\n* pay_co -Payments made via PayCo
\n\n* revolut_pay -Payments made via Revolut Pay.
\n\n* cash -Cash
\n* after_pay -Payments made via Afterpay
\n\n* south_korean_cards - ", "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" ], "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.
Type of the transaction.
\n* authorization -The transaction represents an authorization for capturing the amount\nfrom the customer's payment_source\n.
The transaction represents capture of amount\nfrom the customer's payment_source\n.
The transaction represents a refund of amount\nto the customer's payment_source\n.
Indicates a reversal transaction.
", "enum" : [ "authorization", "payment", "refund", "payment_reversal" ], "example" : null }, "date" : { "type" : "integer", "format" : "unix-time", "deprecated" : false, "description" : "Indicates when this transaction occurred.\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* in_progress -Transaction is being processed by the gateway. This typically happens for direct debit transactions\nor, 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 -When connection with the Gateway gets terminated abruptly. For needs_attention\nstatus Chargebee automatically reconcile the transaction for few gateways, for rest of the gateways you have to use the Reconcile transaction API.\nYou can use this API to update the id_at_gateway\n(Gateway Transaction ID) and status\nfor a needs_attention\ntransaction to be reconciled at par with the gateway.
Learn more\nabout needs_attention\ntransaction status
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
", "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\\* suspicious -\n\nThe transaction has been identified as potentially fraudulent by the gateway\n\\* safe -\n\nThe transaction has been marked as safe\n\\* fraudulent -\n\nThe 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\\* merchant -\n\nPayment initiated on stored payment method by the merchant\n\\* customer -\n\nCustomer 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* scheduled_capture -The transaction was authorized in advance for capture at a later time by a scheduled system job. The capture may succeed or fail, and its outcome is recorded as a linked transaction under linked_payments\n.
The transaction has been created for payment method verification.
\n* blocking_funds -The transaction has been created to block the funds from payment method.
", "enum" : [ "blocking_funds", "verification", "scheduled_capture" ], "example" : null }, "error_code" : { "type" : "string", "deprecated" : false, "description" : "Error code received from the payment gateway on failure.\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.
This is the part of the amount\nwhich has not been invoiced yet and is therefore added to excess_payments\nfor the customer. Applicable only for a transaction of type\n= payment\n.
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.
This is the id\nof the transaction (always of type\n= payment\n) being refunded. Applicable only for transaction of type\n= refund\n.
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.
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.
Current status of this invoice.
\n* pending -The invoice 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_invoicesattribute is set to true.\nThe invoice is yet to be closed (sent for payment collection). All invoices are generated with this status when Metered Billing is enabled for the site.
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.
", "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\\* service_unsatisfactory -\n\nService Unsatisfactory\n\\* other -\n\nCan be set when none of the above reason codes are applicable\n\\* subscription_cancellation -\n\nThis reason will be set automatically for Credit Notes created during cancel subscription operation\n\\* fraudulent -\n\nFRAUDULENT\n\\* order_change -\n\nOrder Change\n\\* subscription_pause -\n\nThis reason will be automatically set to credit notes created during pause/resume subscription operation.\n\\* write_off -\n\nThis reason will be set automatically for the Credit Notes created during invoice [Write Off](https://www.chargebee.com/docs/invoice-operations.html#write-off)\noperation.\n\\* subscription_change -\n\nThis reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html)\nis enabled\n\\* chargeback -\n\nCan be set when you are recording your customer Chargebacks\n\\* waiver -\n\nWaiver\n\\* order_cancellation -\n\nOrder Cancellation\n\\* product_unsatisfactory -\n\nProduct 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\\* voided -\n\nWhen the Credit Note has been cancelled.\n\\* refund_due -\n\nWhen the credits are yet to be used, or have been partially used.\n\\* refunded -\n\nWhen the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded).\n\\* adjusted -\n\nWhen 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* needs_attention -When connection with the Gateway gets terminated abruptly. For needs_attention\nstatus Chargebee automatically reconcile the transaction for few gateways, for rest of the gateways you have to use the Reconcile transaction API.\nYou can use this API to update the id_at_gateway\n(Gateway Transaction ID) and status\nfor a needs_attention\ntransaction to be reconciled at par with the gateway.
Learn more\nabout needs_attention\ntransaction status
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 -Transaction is being processed by the gateway. This typically happens for direct debit transactions\nor, in case of cards, refund transactions. Such transactions can take 2-7 days to complete, depending on the gateway and payment method.
", "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* needs_attention -When connection with the Gateway gets terminated abruptly. For needs_attention\nstatus Chargebee automatically reconcile the transaction for few gateways, for rest of the gateways you have to use the Reconcile transaction API.\nYou can use this API to update the id_at_gateway\n(Gateway Transaction ID) and status\nfor a needs_attention\ntransaction to be reconciled at par with the gateway.
Learn more\nabout needs_attention\ntransaction status
The transaction is successful.
\n* voided -The transaction got voided or authorization expired at gateway.
\n* in_progress -Transaction is being processed by the gateway. This typically happens for direct debit transactions\nor, 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.
", "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.
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.
If any invoice is to be created for a subscription all the unbilled charges associated with the subscription will be included in that invoice.
If any invoice is to be created for a customer, all the unbilled charges associated with its subscriptions will be included in that invoice.
Any automatic invoice creation like renewal, activation, etc., will include the unbilled charges.
Subscriptions are invoiced at the start of every term based on the recurring items and charged immediately against the customer's credit card if 'auto_collection' is turned 'on', otherwise the resulting invoice will be created as 'Payment Due'.
If consolidated invoicing is enabled, the charges during the subscription renewals/activations will be held and consolidated at the last renewal/activation that takes place on that particular day.
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\nis enabled.
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.
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\nis enabled.
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\nis enabled.
The decimal representation of the quantity purchased from this tier. Returned when the line_item\nis quantity-based and multi-decimal pricing\nis enabled.
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\nis enabled.
Type of the credit transfer
\n* eu_automated_bank_transfer -EU Automated Bank Transfer
\n* ach_credit -ACH Credit Transfer
\nThis scheme is deprecated. Instead of ach_credit\nuse us_automated_bank_transfer\n.
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 -SEPA Credit Transfer
\nThis scheme is deprecated. Instead of sepa_credit\nuse eu_automated_bank_transfer\n.
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.
Indicates whether the webhook endpoint is disabled. If true\n, the endpoint is disabled; if false\n, it is enabled.
Indicates the response schema used in the webhook payload, based on the product catalog version configured for the site.
\nNote\nThis field is only applicable if the site is in compat mode.
The webhook payload follows the Product Catalog 2.0\nschema and uses the Items API model\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 -The webhook payload follows the Product Catalog 1.0\nschema and uses the Plans\nand Addons\nmodel.
", "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\\* order_ready_to_ship - \\* omnichannel_subscription_imported - \\* payment_source_expiring - \\* omnichannel_subscription_item_grace_period_started - \\* plan_updated - \\* subscription_advance_invoice_schedule_removed - \\* plan_deleted - \\* card_added - \\* customer_moved_out - \\* gift_updated - \\* payment_source_expired - \\* invoice_generated - \\* customer_deleted - \\* plan_created - \\* customer_moved_in - \\* payment_succeeded - \\* order_ready_to_process - \\* subscription_scheduled_changes_removed - \\* contract_term_renewed - \\* payment_failed - \\* coupon_codes_deleted - \\* token_created - \\* customer_changed - \\* subscription_scheduled_resumption_removed - \\* card_expired - \\* voucher_expired - \\* omnichannel_one_time_order_created - \\* addon_created - \\* subscription_canceled_with_backdating - \\* omnichannel_subscription_item_expired - \\* hierarchy_created - \\* order_cancelled - \\* addon_deleted - \\* unbilled_charges_invoiced - \\* omnichannel_subscription_item_renewed - \\* authorization_succeeded - \\* gift_claimed - \\* omnichannel_one_time_order_item_cancelled - \\* order_deleted - \\* payment_initiated - \\* unbilled_charges_voided - \\* omnichannel_subscription_item_scheduled_change_removed - \\* order_resent - \\* subscription_created_with_backdating - \\* subscription_reactivated - \\* coupon_updated - \\* payment_source_locally_deleted - \\* authorization_voided - \\* coupon_set_created - \\* subscription_cancelled - \\* subscription_paused - \\* token_expired - \\* transaction_updated - \\* omnichannel_subscription_item_reactivated - \\* subscription_activated_with_backdating - \\* invoice_deleted - \\* omnichannel_subscription_created - \\* order_created - \\* quote_deleted - \\* subscription_reactivated_with_backdating - \\* invoice_updated - \\* unbilled_charges_deleted - \\* subscription_moved_out - \\* subscription_shipping_address_updated - \\* token_consumed - \\* transaction_deleted - \\* subscription_ramp_deleted - \\* subscription_trial_extended - \\* coupon_codes_updated - \\* omnichannel_subscription_item_dunning_started - \\* pending_invoice_created - \\* card_updated - \\* gift_unclaimed - \\* subscription_advance_invoice_schedule_added - \\* subscription_trial_end_reminder - \\* hierarchy_deleted - \\* subscription_changed - \\* gift_scheduled - \\* invoice_generated_with_backdating - \\* payment_intent_updated - \\* virtual_bank_account_added - \\* subscription_movement_failed - \\* tax_withheld_deleted - \\* omnichannel_subscription_item_change_scheduled - \\* pending_invoice_updated - \\* promotional_credits_deducted - \\* payment_refunded - \\* subscription_ramp_created - \\* omnichannel_subscription_item_cancellation_scheduled - \\* subscription_started - \\* credit_note_deleted - \\* payment_source_updated - \\* credit_note_updated - \\* quote_created - \\* credit_note_created - \\* gift_expired - \\* transaction_created - \\* contract_term_terminated - \\* payment_source_deleted - \\* contract_term_cancelled - \\* sales_order_created - \\* subscription_cancellation_reminder - \\* coupon_codes_added - \\* order_returned - \\* rule_created - \\* subscription_activated - \\* omnichannel_subscription_item_resumed - \\* subscription_renewal_reminder - \\* omnichannel_subscription_item_changed - \\* omnichannel_subscription_item_grace_period_expired - \\* subscription_ramp_updated - \\* promotional_credits_added - \\* virtual_bank_account_deleted - \\* dunning_updated - \\* subscription_changed_with_backdating - \\* rule_updated - \\* mrr_updated - \\* payment_source_added - \\* subscription_ramp_applied - \\* card_deleted - \\* omnichannel_subscription_item_pause_scheduled - \\* sales_order_updated - \\* subscription_cancellation_scheduled - \\* subscription_deleted - \\* subscription_moved_in - \\* record_purchase_failed - \\* subscription_changes_scheduled - \\* voucher_create_failed - \\* omnichannel_subscription_item_dunning_expired - \\* coupon_set_deleted - \\* coupon_set_updated - \\* addon_updated - \\* subscription_items_renewed - \\* subscription_scheduled_cancellation_removed - \\* card_expiry_reminder - \\* coupon_created - \\* subscription_resumption_scheduled - \\* omnichannel_subscription_item_upgraded - \\* order_updated - \\* omnichannel_subscription_item_resubscribed - \\* refund_initiated - \\* omnichannel_subscription_item_downgraded - \\* gift_cancelled - \\* subscription_renewed - \\* omnichannel_subscription_item_cancelled - \\* subscription_scheduled_pause_removed - \\* omnichannel_subscription_item_paused - \\* omnichannel_subscription_item_scheduled_cancellation_removed - \\* quote_updated - \\* customer_created - \\* tax_withheld_refunded - \\* coupon_deleted - \\* order_delivered - \\* subscription_pause_scheduled - \\* subscription_advance_invoice_schedule_updated - \\* voucher_created - \\* credit_note_created_with_backdating - \\* unbilled_charges_created - \\* subscription_ramp_drafted - \\* rule_deleted - \\* payment_intent_created - \\* contract_term_created - \\* contract_term_completed - \\* tax_withheld_recorded - \\* subscription_resumed - \\* virtual_bank_account_updated - \\* subscription_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", "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" ], "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" } }, "sales-order-id" : { "name" : "sales-order-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "in-app-subscription-app-id" : { "name" : "in-app-subscription-app-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "quote-id" : { "name" : "quote-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "limit" : { "name" : "limit", "in" : "query", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "default" : 10, "description" : "The number of resources to be returned.", "x-cb-is-pagination-parameter" : true, "maximum" : 100, "minimum" : 1, "example" : null } }, "include_deleted" : { "name" : "include_deleted", "in" : "query", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean", "default" : false, "description" : "Indicates whether to include deleted objects in the list. The deleted objects have the attribute `deleted` as `true`." } }, "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" } }, "pc2-migration-item-family-id" : { "name" : "pc2-migration-item-family-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "offset" : { "name" : "offset", "in" : "query", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "description" : "Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.", "x-cb-is-pagination-parameter" : true, "maxLength" : 1000, "example" : null } }, "entitlement-override-id" : { "name" : "entitlement-override-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "subscription-id" : { "name" : "subscription-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "hosted-page-id" : { "name" : "hosted-page-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "credit-note-id" : { "name" : "credit-note-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "virtual-bank-account-id" : { "name" : "virtual-bank-account-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "chargebee-event-webhook" : { "name" : "chargebee-event-webhook", "in" : "header", "description" : " skip only webhooks", "required" : false, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : " skip only webhooks", "enum" : [ "all-disabled" ] } }, "e-invoicing-country-country" : { "name" : "e-invoicing-country-country", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "coupon-set-id" : { "name" : "coupon-set-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "non-subscription-app-id" : { "name" : "non-subscription-app-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "portal-session-id" : { "name" : "portal-session-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "attached-item-id" : { "name" : "attached-item-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "plan-id" : { "name" : "plan-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "chargebee-request-origin-user-encoded" : { "name" : "chargebee-request-origin-user-encoded", "in" : "header", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "email", "description" : "The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.", "example" : "dXNlci7QutCy0ZbRgtC+0YfQutCwQGV4YW1wbGUuY29t" } }, "meter-id" : { "name" : "meter-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "business-entity-id" : { "name" : "business-entity-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "item-id" : { "name" : "item-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "subscription-entitlement-id" : { "name" : "subscription-entitlement-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "customer-id" : { "name" : "customer-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "cust-payment-source-id" : { "name" : "cust-payment-source-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "site-currency-id" : { "name" : "site-currency-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "chargebee-request-origin-device" : { "name" : "chargebee-request-origin-device", "in" : "header", "description" : "The device from which the customer has made the request", "required" : false, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "description" : "The device from which the customer has made the request", "example" : "Android" } }, "thunking-plan-id" : { "name" : "thunking-plan-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "tp-site-user-domain" : { "name" : "tp-site-user-domain", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "event-id" : { "name" : "event-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "async-response-id" : { "name" : "async-response-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "site-owner-id" : { "name" : "site-owner-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "rule-id" : { "name" : "rule-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "time-machine-name" : { "name" : "time-machine-name", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "item-family-id" : { "name" : "item-family-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "product-id" : { "name" : "product-id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "site-id" : { "name" : "site-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" } }, "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.
", "post" : { "summary" : "Triggered when the subscription is scheduled to pause.", "description" : "Triggered when the subscription is scheduled to pause.
", "operationId" : "onSubscription_pause_scheduledWebhook", "requestBody" : { "description" : "Payload for subscription_pause_scheduled event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionPauseScheduledEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "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.
", "post" : { "summary" : "Triggered when an order is delivered.", "description" : "Triggered when an order is delivered.
", "operationId" : "onOrder_deliveredWebhook", "requestBody" : { "description" : "Payload for order_delivered event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderDeliveredEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_advance_invoice_schedule_added" : { "description" : "Triggered when advance invoice is scheduled for a subscription.
", "post" : { "summary" : "Triggered when advance invoice is scheduled for a subscription.", "description" : "Triggered when advance invoice is scheduled for a subscription.
", "operationId" : "onSubscription_advance_invoice_schedule_addedWebhook", "requestBody" : { "description" : "Payload for subscription_advance_invoice_schedule_added event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionAdvanceInvoiceScheduleAddedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "gift_expired" : { "description" : "Triggered when a gift expires.
", "post" : { "summary" : "Triggered when a gift expires.", "description" : "Triggered when a gift expires.
", "operationId" : "onGift_expiredWebhook", "requestBody" : { "description" : "Payload for gift_expired event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GiftExpiredEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "tax_withheld_deleted" : { "description" : "Triggered when a tax withheld is deleted.
", "post" : { "summary" : "Triggered when a tax withheld is deleted.", "description" : "Triggered when a tax withheld is deleted.
", "operationId" : "onTax_withheld_deletedWebhook", "requestBody" : { "description" : "Payload for tax_withheld_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxWithheldDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "coupon_codes_added" : { "description" : "Triggered when coupon codes are added in coupon set.
", "post" : { "summary" : "Triggered when coupon codes are added in coupon set.", "description" : "Triggered when coupon codes are added in coupon set.
", "operationId" : "onCoupon_codes_addedWebhook", "requestBody" : { "description" : "Payload for coupon_codes_added event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CouponCodesAddedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "unbilled_charges_deleted" : { "description" : "Triggered when unbilled charges are deleted
", "post" : { "summary" : "Triggered when unbilled charges are deleted", "description" : "Triggered when unbilled charges are deleted
", "operationId" : "onUnbilled_charges_deletedWebhook", "requestBody" : { "description" : "Payload for unbilled_charges_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UnbilledChargesDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "gift_cancelled" : { "description" : "Triggered when gift is cancelled.
", "post" : { "summary" : "Triggered when gift is cancelled.", "description" : "Triggered when gift is cancelled.
", "operationId" : "onGift_cancelledWebhook", "requestBody" : { "description" : "Payload for gift_cancelled event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GiftCancelledEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "coupon_updated" : { "description" : "Triggered when a coupon is changed.
", "post" : { "summary" : "Triggered when a coupon is changed.", "description" : "Triggered when a coupon is changed.
", "operationId" : "onCoupon_updatedWebhook", "requestBody" : { "description" : "Payload for coupon_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CouponUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "order_cancelled" : { "description" : "Triggered when an order is cancelled.
", "post" : { "summary" : "Triggered when an order is cancelled.", "description" : "Triggered when an order is cancelled.
", "operationId" : "onOrder_cancelledWebhook", "requestBody" : { "description" : "Payload for order_cancelled event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderCancelledEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "coupon_deleted" : { "description" : "Triggered when a coupon is deleted.
", "post" : { "summary" : "Triggered when a coupon is deleted.", "description" : "Triggered when a coupon is deleted.
", "operationId" : "onCoupon_deletedWebhook", "requestBody" : { "description" : "Payload for coupon_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CouponDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_scheduled_changes_removed" : { "description" : "Triggered when scheduled change for the subscription is removed.
", "post" : { "summary" : "Triggered when scheduled change for the subscription is removed.", "description" : "Triggered when scheduled change for the subscription is removed.
", "operationId" : "onSubscription_scheduled_changes_removedWebhook", "requestBody" : { "description" : "Payload for subscription_scheduled_changes_removed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionScheduledChangesRemovedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "pending_invoice_created" : { "description" : "Event triggered (in the case of metered billing) when a "Pending" invoice is created that has usage related charges or line items to be added, before being closed. This is triggered only when the "Notify for Pending Invoices" option is enabled.
", "post" : { "summary" : "Event triggered (in the case of metered billing) when a \"Pending\" invoice is created that has usage related charges or line items to be added, before being closed. This is triggered only when the “Notify for Pending Invoices” option is enabled.", "description" : "Event triggered (in the case of metered billing) when a "Pending" invoice is created that has usage related charges or line items to be added, before being closed. This is triggered only when the "Notify for Pending Invoices" option is enabled.
", "operationId" : "onPending_invoice_createdWebhook", "requestBody" : { "description" : "Payload for pending_invoice_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PendingInvoiceCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "unbilled_charges_created" : { "description" : "Triggered when unbilled charges are created
", "post" : { "summary" : "Triggered when unbilled charges are created", "description" : "Triggered when unbilled charges are created
", "operationId" : "onUnbilled_charges_createdWebhook", "requestBody" : { "description" : "Payload for unbilled_charges_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UnbilledChargesCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_resumed" : { "description" : "Triggered when the subscription is resumed.
", "post" : { "summary" : "Triggered when the subscription is resumed.", "description" : "Triggered when the subscription is resumed.
", "operationId" : "onSubscription_resumedWebhook", "requestBody" : { "description" : "Payload for subscription_resumed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionResumedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_cancelled" : { "description" : "Triggered when the subscription is cancelled. If it is cancelled due to non payment or because the card details are not present, the subscription will have the possible reason as 'cancel_reason'.
", "post" : { "summary" : "Triggered when the subscription is cancelled. If it is cancelled due to non payment or because the card details are not present, the subscription will have the possible reason as 'cancel_reason'.", "description" : "Triggered when the subscription is cancelled. If it is cancelled due to non payment or because the card details are not present, the subscription will have the possible reason as 'cancel_reason'.
", "operationId" : "onSubscription_cancelledWebhook", "requestBody" : { "description" : "Payload for subscription_cancelled event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionCancelledEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "payment_source_deleted" : { "description" : "Triggered when a payment source is deleted.
", "post" : { "summary" : "Triggered when a payment source is deleted.", "description" : "Triggered when a payment source is deleted.
", "operationId" : "onPayment_source_deletedWebhook", "requestBody" : { "description" : "Payload for payment_source_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentSourceDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "quote_deleted" : { "description" : "Event triggered when a new quote is deleted.
", "post" : { "summary" : "Event triggered when a new quote is deleted.", "description" : "Event triggered when a new quote is deleted.
", "operationId" : "onQuote_deletedWebhook", "requestBody" : { "description" : "Payload for quote_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/QuoteDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "invoice_updated" : { "description" : "Triggered when changes are made to a finalized invoice, including voiding, deletion, invoice address updates, status changes, and payment changes such as applying or removing a payment, applying or removing a credit, and credit note creation. pending_invoice_updated is triggered for changes specific to pending invoices; invoice_updated covers all other invoice changes.
", "post" : { "summary" : "Triggered when you make the following changes to a pending invoice - add a charge, add a non-recurring addon, or delete a line item.", "description" : "Triggered when changes are made to a finalized invoice, including voiding, deletion, invoice address updates, status changes, and payment changes such as applying or removing a payment, applying or removing a credit, and credit note creation. pending_invoice_updated is triggered for changes specific to pending invoices; invoice_updated covers all other invoice changes.
", "operationId" : "onInvoice_updatedWebhook", "requestBody" : { "description" : "Payload for invoice_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/InvoiceUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "coupon_set_updated" : { "description" : "Triggered when a coupon set is updated.
", "post" : { "summary" : "Triggered when a coupon set is updated.", "description" : "Triggered when a coupon set is updated.
", "operationId" : "onCoupon_set_updatedWebhook", "requestBody" : { "description" : "Payload for coupon_set_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CouponSetUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_advance_invoice_schedule_removed" : { "description" : "Triggered when scheduled advance invoice is removed for a subscription.
", "post" : { "summary" : "Triggered when scheduled advance invoice is removed for a subscription.", "description" : "Triggered when scheduled advance invoice is removed for a subscription.
", "operationId" : "onSubscription_advance_invoice_schedule_removedWebhook", "requestBody" : { "description" : "Payload for subscription_advance_invoice_schedule_removed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionAdvanceInvoiceScheduleRemovedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_activated_with_backdating" : { "description" : "Triggered after the subscription changes to active from another status, while the change is backdated.
Triggered after the subscription changes to active from another status, while the change is backdated.
Triggered when a card is deleted for a customer.
", "post" : { "summary" : "Triggered when a card is deleted for a customer.", "description" : "Triggered when a card is deleted for a customer.
", "operationId" : "onCard_deletedWebhook", "requestBody" : { "description" : "Payload for card_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CardDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "order_ready_to_ship" : { "description" : "Triggered when an order reaches it's shipping date.
", "post" : { "summary" : "Triggered when an order reaches it's shipping date.", "description" : "Triggered when an order reaches it's shipping date.
", "operationId" : "onOrder_ready_to_shipWebhook", "requestBody" : { "description" : "Payload for order_ready_to_ship event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderReadyToShipEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_trial_end_reminder" : { "description" : "Triggered 6 days prior to the trial period's end date.
", "post" : { "summary" : "Triggered 6 days prior to the trial period's end date.", "description" : "Triggered 6 days prior to the trial period's end date.
", "operationId" : "onSubscription_trial_end_reminderWebhook", "requestBody" : { "description" : "Payload for subscription_trial_end_reminder event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionTrialEndReminderEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_shipping_address_updated" : { "description" : "Triggered when shipping address is added or updated for a subscription.
", "post" : { "summary" : "Triggered when shipping address is added or updated for a subscription.", "description" : "Triggered when shipping address is added or updated for a subscription.
", "operationId" : "onSubscription_shipping_address_updatedWebhook", "requestBody" : { "description" : "Payload for subscription_shipping_address_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionShippingAddressUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "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.
", "post" : { "summary" : "Triggered when the Payment voucher Creation fails.", "description" : "Triggered when the Payment voucher Creation fails.
", "operationId" : "onVoucher_create_failedWebhook", "requestBody" : { "description" : "Payload for voucher_create_failed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VoucherCreateFailedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "gift_claimed" : { "description" : "Triggered when a gift is claimed.
", "post" : { "summary" : "Triggered when a gift is claimed.", "description" : "Triggered when a gift is claimed.
", "operationId" : "onGift_claimedWebhook", "requestBody" : { "description" : "Payload for gift_claimed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GiftClaimedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_scheduled_resumption_removed" : { "description" : "Triggered when scheduled resumption is removed for the subscription.
", "post" : { "summary" : "Triggered when scheduled resumption is removed for the subscription.", "description" : "Triggered when scheduled resumption is removed for the subscription.
", "operationId" : "onSubscription_scheduled_resumption_removedWebhook", "requestBody" : { "description" : "Payload for subscription_scheduled_resumption_removed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionScheduledResumptionRemovedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "payment_initiated" : { "description" : "Triggered when a payment is initiated via direct debit.
", "post" : { "summary" : "Triggered when a payment is initiated via direct debit.", "description" : "Triggered when a payment is initiated via direct debit.
", "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.
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.
Triggered when a customer is deleted.
", "post" : { "summary" : "Triggered when a customer is deleted.", "description" : "Triggered when a customer is deleted.
", "operationId" : "onCustomer_deletedWebhook", "requestBody" : { "description" : "Payload for customer_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomerDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "token_expired" : { "description" : "Triggered when a nonce is expired.
", "post" : { "summary" : "Triggered when a nonce is expired.", "description" : "Triggered when a nonce is expired.
", "operationId" : "onToken_expiredWebhook", "requestBody" : { "description" : "Payload for token_expired event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TokenExpiredEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "card_added" : { "description" : "Triggered when a card is added for a customer.
", "post" : { "summary" : "Triggered when a card is added for a customer.", "description" : "Triggered when a card is added for a customer.
", "operationId" : "onCard_addedWebhook", "requestBody" : { "description" : "Payload for card_added event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CardAddedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "coupon_created" : { "description" : "Triggered when a coupon is created.
", "post" : { "summary" : "Triggered when a coupon is created.", "description" : "Triggered when a coupon is created.
", "operationId" : "onCoupon_createdWebhook", "requestBody" : { "description" : "Payload for coupon_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CouponCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "refund_initiated" : { "description" : "Triggered when a refund is initiated via direct debit.
", "post" : { "summary" : "Triggered when a refund is initiated via direct debit.", "description" : "Triggered when a refund is initiated via direct debit.
", "operationId" : "onRefund_initiatedWebhook", "requestBody" : { "description" : "Payload for refund_initiated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RefundInitiatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "invoice_generated_with_backdating" : { "description" : "Triggered when an invoice has been created with date set to a value in the past. However, if the invoice is created with a pending status and the site setting is to set invoice.date to the date of closing the invoice, this event is never triggered.
", "post" : { "summary" : "Triggered when an invoice has been created with date set to a value in the past. However, if the invoice is created with a pending status and the site setting is to set invoice.date to the date of closing the invoice, this event is never triggered.", "description" : "Triggered when an invoice has been created with date set to a value in the past. However, if the invoice is created with a pending status and the site setting is to set invoice.date to the date of closing the invoice, this event is never triggered.
", "operationId" : "onInvoice_generated_with_backdatingWebhook", "requestBody" : { "description" : "Payload for invoice_generated_with_backdating event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/InvoiceGeneratedWithBackdatingEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "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.
", "post" : { "summary" : "Triggered when a virtual bank account is deleted.", "description" : "Triggered when a virtual bank account is deleted.
", "operationId" : "onVirtual_bank_account_deletedWebhook", "requestBody" : { "description" : "Payload for virtual_bank_account_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VirtualBankAccountDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_created" : { "description" : "Triggered when a new subscription is created.
", "post" : { "summary" : "Triggered when a new subscription is created.", "description" : "Triggered when a new subscription is created.
", "operationId" : "onSubscription_createdWebhook", "requestBody" : { "description" : "Payload for subscription_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "voucher_created" : { "description" : "Triggered when a Payment voucher is created.
", "post" : { "summary" : "Triggered when a Payment voucher is created.", "description" : "Triggered when a Payment voucher is created.
", "operationId" : "onVoucher_createdWebhook", "requestBody" : { "description" : "Payload for voucher_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VoucherCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "rule_updated" : { "post" : { "summary" : "Triggered when a rule is updated", "operationId" : "onRule_updatedWebhook", "requestBody" : { "description" : "Payload for rule_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RuleUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "payment_source_locally_deleted" : { "description" : "Triggered when a payment source is deleted at Chargebee.
", "post" : { "summary" : "Triggered when a payment source is deleted at Chargebee.", "description" : "Triggered when a payment source is deleted at Chargebee.
", "operationId" : "onPayment_source_locally_deletedWebhook", "requestBody" : { "description" : "Payload for payment_source_locally_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentSourceLocallyDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "order_returned" : { "description" : "Triggered when an order is returned.
", "post" : { "summary" : "Triggered when an order is returned.", "description" : "Triggered when an order is returned.
", "operationId" : "onOrder_returnedWebhook", "requestBody" : { "description" : "Payload for order_returned event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderReturnedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_deleted" : { "description" : "Triggered when a subscription is deleted.
", "post" : { "summary" : "Triggered when a subscription is deleted.", "description" : "Triggered when a subscription is deleted.
", "operationId" : "onSubscription_deletedWebhook", "requestBody" : { "description" : "Payload for subscription_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "invoice_generated" : { "description" : "Event triggered when a new invoice is created except when created with status as pending. For pending invoices, this event is triggered when the invoice is closed.
", "post" : { "summary" : "Event triggered when a new invoice is created except when created with status as pending. For pending invoices, this event is triggered when the invoice is closed.", "description" : "Event triggered when a new invoice is created except when created with status as pending. For pending invoices, this event is triggered when the invoice is closed.
", "operationId" : "onInvoice_generatedWebhook", "requestBody" : { "description" : "Payload for invoice_generated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/InvoiceGeneratedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "voucher_expired" : { "description" : "Triggered when a Payment voucher is Expired.
", "post" : { "summary" : "Triggered when a Payment voucher is Expired.", "description" : "Triggered when a Payment voucher is Expired.
", "operationId" : "onVoucher_expiredWebhook", "requestBody" : { "description" : "Payload for voucher_expired event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VoucherExpiredEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "authorization_succeeded" : { "description" : "Triggered when a authorization transaction is created.
", "post" : { "summary" : "Triggered when a authorization transaction is created.", "description" : "Triggered when a authorization transaction is created.
", "operationId" : "onAuthorization_succeededWebhook", "requestBody" : { "description" : "Payload for authorization_succeeded event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationSucceededEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "payment_source_added" : { "description" : "Triggered when a payment source is added.
", "post" : { "summary" : "Triggered when a payment source is added.", "description" : "Triggered when a payment source is added.
", "operationId" : "onPayment_source_addedWebhook", "requestBody" : { "description" : "Payload for payment_source_added event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentSourceAddedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "gift_scheduled" : { "description" : "Triggered when a new gift is created.
", "post" : { "summary" : "Triggered when a new gift is created.", "description" : "Triggered when a new gift is created.
", "operationId" : "onGift_scheduledWebhook", "requestBody" : { "description" : "Payload for gift_scheduled event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GiftScheduledEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_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.
", "post" : { "summary" : "Triggered when subscription changes are scheduled for later. Changes will be applied at the end of current term.", "description" : "Triggered when subscription changes are scheduled for later. Changes will be applied at the end of current term.
", "operationId" : "onSubscription_changes_scheduledWebhook", "requestBody" : { "description" : "Payload for subscription_changes_scheduled event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionChangesScheduledEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_changed_with_backdating" : { "description" : "Triggered when a subscription is changed with changes_scheduled_at set to a value in the past.
", "post" : { "summary" : "Triggered when a subscription is changed with changes_scheduled_at set to a value in the past.", "description" : "Triggered when a subscription is changed with changes_scheduled_at set to a value in the past.
", "operationId" : "onSubscription_changed_with_backdatingWebhook", "requestBody" : { "description" : "Payload for subscription_changed_with_backdating event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionChangedWithBackdatingEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_scheduled_cancellation_removed" : { "description" : "Triggered when scheduled cancellation is removed for the subscription.
", "post" : { "summary" : "Triggered when scheduled cancellation is removed for the subscription.", "description" : "Triggered when scheduled cancellation is removed for the subscription.
", "operationId" : "onSubscription_scheduled_cancellation_removedWebhook", "requestBody" : { "description" : "Payload for subscription_scheduled_cancellation_removed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionScheduledCancellationRemovedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "payment_refunded" : { "description" : "Triggered when a payment refund is made.
", "post" : { "summary" : "Triggered when a payment refund is made.", "description" : "Triggered when a payment refund is made.
", "operationId" : "onPayment_refundedWebhook", "requestBody" : { "description" : "Payload for payment_refunded event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentRefundedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "gift_unclaimed" : { "description" : "Triggered when a new gift is unclaimed and is ready to be claimed.
", "post" : { "summary" : "Triggered when a new gift is unclaimed and is ready to be claimed.", "description" : "Triggered when a new gift is unclaimed and is ready to be claimed.
", "operationId" : "onGift_unclaimedWebhook", "requestBody" : { "description" : "Payload for gift_unclaimed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GiftUnclaimedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "virtual_bank_account_added" : { "description" : "Triggered when a virtual bank account is added.
", "post" : { "summary" : "Triggered when a virtual bank account is added.", "description" : "Triggered when a virtual bank account is added.
", "operationId" : "onVirtual_bank_account_addedWebhook", "requestBody" : { "description" : "Payload for virtual_bank_account_added event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VirtualBankAccountAddedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "payment_intent_created" : { "description" : "Triggered when a payment intent is created.
", "post" : { "summary" : "Triggered when a payment intent is created.", "description" : "Triggered when a payment intent is created.
", "operationId" : "onPayment_intent_createdWebhook", "requestBody" : { "description" : "Payload for payment_intent_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentIntentCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "transaction_created" : { "description" : "Triggered when a transaction is recorded.
", "post" : { "summary" : "Triggered when a transaction is recorded.", "description" : "Triggered when a transaction is recorded.
", "operationId" : "onTransaction_createdWebhook", "requestBody" : { "description" : "Payload for transaction_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TransactionCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "credit_note_created_with_backdating" : { "description" : "Triggered when a credit note is created such that generated_at is a value in the past.
", "post" : { "summary" : "Triggered when a credit note is created such that generated_at is a value in the past.", "description" : "Triggered when a credit note is created such that generated_at is a value in the past.
", "operationId" : "onCredit_note_created_with_backdatingWebhook", "requestBody" : { "description" : "Payload for credit_note_created_with_backdating event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreditNoteCreatedWithBackdatingEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "contract_term_terminated" : { "description" : "Triggered when contract term is terminated.
", "post" : { "summary" : "Triggered when contract term is terminated.", "description" : "Triggered when contract term is terminated.
", "operationId" : "onContract_term_terminatedWebhook", "requestBody" : { "description" : "Payload for contract_term_terminated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ContractTermTerminatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "order_created" : { "description" : "Triggered when an order is generated.
", "post" : { "summary" : "Triggered when an order is generated.", "description" : "Triggered when an order is generated.
", "operationId" : "onOrder_createdWebhook", "requestBody" : { "description" : "Payload for order_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "payment_succeeded" : { "description" : "Triggered when the payment is successfully collected.
", "post" : { "summary" : "Triggered when the payment is successfully collected.", "description" : "Triggered when the payment is successfully collected.
", "operationId" : "onPayment_succeededWebhook", "requestBody" : { "description" : "Payload for payment_succeeded event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentSucceededEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "plan_deleted" : { "description" : "Triggered when a plan is deleted.
", "post" : { "summary" : "Triggered when a plan is deleted.", "description" : "Triggered when a plan is deleted.
", "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.
", "post" : { "summary" : "Triggered when a subscription is canceled with cancel_at set to a value in the past.", "description" : "Triggered when a subscription is canceled with cancel_at set to a value in the past.
", "operationId" : "onSubscription_canceled_with_backdatingWebhook", "requestBody" : { "description" : "Payload for subscription_canceled_with_backdating event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionCanceledWithBackdatingEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "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
", "post" : { "summary" : "Triggered when unbilled charges are voided", "description" : "Triggered when unbilled charges are voided
", "operationId" : "onUnbilled_charges_voidedWebhook", "requestBody" : { "description" : "Payload for unbilled_charges_voided event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UnbilledChargesVoidedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "quote_created" : { "description" : "Event triggered when a new quote is generated.
", "post" : { "summary" : "Event triggered when a new quote is generated.", "description" : "Event triggered when a new quote is generated.
", "operationId" : "onQuote_createdWebhook", "requestBody" : { "description" : "Payload for quote_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/QuoteCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "customer_moved_in" : { "description" : "Triggered when a customer is copied from another site.
", "post" : { "summary" : "Triggered when a customer is copied from another site.", "description" : "Triggered when a customer is copied from another site.
", "operationId" : "onCustomer_moved_inWebhook", "requestBody" : { "description" : "Payload for customer_moved_in event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomerMovedInEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "coupon_set_deleted" : { "description" : "Triggered when a coupon set is deleted.
", "post" : { "summary" : "Triggered when a coupon set is deleted.", "description" : "Triggered when a coupon set is deleted.
", "operationId" : "onCoupon_set_deletedWebhook", "requestBody" : { "description" : "Payload for coupon_set_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CouponSetDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_advance_invoice_schedule_updated" : { "description" : "Triggered when scheduled advance invoice is updated for a subscription.
", "post" : { "summary" : "Triggered when scheduled advance invoice is updated for a subscription.", "description" : "Triggered when scheduled advance invoice is updated for a subscription.
", "operationId" : "onSubscription_advance_invoice_schedule_updatedWebhook", "requestBody" : { "description" : "Payload for subscription_advance_invoice_schedule_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionAdvanceInvoiceScheduleUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "customer_changed" : { "description" : "Triggered when a customer is changed.
", "post" : { "summary" : "Triggered when a customer is changed.", "description" : "Triggered when a customer is changed.
", "operationId" : "onCustomer_changedWebhook", "requestBody" : { "description" : "Payload for customer_changed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomerChangedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_started" : { "description" : "Triggered when a 'future' subscription gets started.
", "post" : { "summary" : "Triggered when a 'future' subscription gets started.", "description" : "Triggered when a 'future' subscription gets started.
", "operationId" : "onSubscription_startedWebhook", "requestBody" : { "description" : "Payload for subscription_started event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionStartedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_activated" : { "description" : "Triggered after the subscription has been moved from "Trial" to "Active" state.
", "post" : { "summary" : "Triggered after the subscription has been moved from \"Trial\" to \"Active\" state.", "description" : "Triggered after the subscription has been moved from "Trial" to "Active" state.
", "operationId" : "onSubscription_activatedWebhook", "requestBody" : { "description" : "Payload for subscription_activated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionActivatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "payment_source_expiring" : { "description" : "Triggered when the customer's payment source is expiring soon. Triggered 30 days before the expiry date.
", "post" : { "summary" : "Triggered when the customer's payment source is expiring soon. Triggered 30 days before the expiry date.", "description" : "Triggered when the customer's payment source is expiring soon. Triggered 30 days before the expiry date.
", "operationId" : "onPayment_source_expiringWebhook", "requestBody" : { "description" : "Payload for payment_source_expiring event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentSourceExpiringEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_reactivated" : { "description" : "Triggered when the subscription is moved from cancelled status to active or in_trial.
Triggered when the subscription is moved from cancelled status to active or in_trial.
Triggered when an order is updated.
", "post" : { "summary" : "Triggered when an order is updated.", "description" : "Triggered when an order is updated.
", "operationId" : "onOrder_updatedWebhook", "requestBody" : { "description" : "Payload for order_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_scheduled_pause_removed" : { "description" : "Triggered when scheduled pause is removed for the subscription.
", "post" : { "summary" : "Triggered when scheduled pause is removed for the subscription.", "description" : "Triggered when scheduled pause is removed for the subscription.
", "operationId" : "onSubscription_scheduled_pause_removedWebhook", "requestBody" : { "description" : "Payload for subscription_scheduled_pause_removed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionScheduledPauseRemovedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_cancellation_reminder" : { "description" : "Triggered 6 days prior to the scheduled cancellation date.
", "post" : { "summary" : "Triggered 6 days prior to the scheduled cancellation date.", "description" : "Triggered 6 days prior to the scheduled cancellation date.
", "operationId" : "onSubscription_cancellation_reminderWebhook", "requestBody" : { "description" : "Payload for subscription_cancellation_reminder event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionCancellationReminderEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "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.
", "post" : { "summary" : "Triggered when an addon is deleted.", "description" : "Triggered when an addon is deleted.
", "operationId" : "onAddon_deletedWebhook", "requestBody" : { "description" : "Payload for addon_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AddonDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_created_with_backdating" : { "description" : "Triggered when a subscription is created and the value of subscription.started_at is in the past.
", "post" : { "summary" : "Triggered when a subscription is created and the value of subscription.started_at is in the past.", "description" : "Triggered when a subscription is created and the value of subscription.started_at is in the past.
", "operationId" : "onSubscription_created_with_backdatingWebhook", "requestBody" : { "description" : "Payload for subscription_created_with_backdating event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionCreatedWithBackdatingEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "order_deleted" : { "description" : "Triggered when an order is deleted.
", "post" : { "summary" : "Triggered when an order is deleted.", "description" : "Triggered when an order is deleted.
", "operationId" : "onOrder_deletedWebhook", "requestBody" : { "description" : "Payload for order_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "token_consumed" : { "description" : "Triggered when a nonce is consumed.
", "post" : { "summary" : "Triggered when a nonce is consumed.", "description" : "Triggered when a nonce is consumed.
", "operationId" : "onToken_consumedWebhook", "requestBody" : { "description" : "Payload for token_consumed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TokenConsumedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "addon_updated" : { "description" : "Triggered when an addon is changed.
", "post" : { "summary" : "Triggered when an addon is changed.", "description" : "Triggered when an addon is changed.
", "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.
", "post" : { "summary" : "Triggered when a hierarchy is deleted.", "description" : "Triggered when a hierarchy is deleted.
", "operationId" : "onHierarchy_deletedWebhook", "requestBody" : { "description" : "Payload for hierarchy_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/HierarchyDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_cancellation_scheduled" : { "description" : "Triggered when subscription is scheduled to cancel at end of current term.
", "post" : { "summary" : "Triggered when subscription is scheduled to cancel at end of current term.", "description" : "Triggered when subscription is scheduled to cancel at end of current term.
", "operationId" : "onSubscription_cancellation_scheduledWebhook", "requestBody" : { "description" : "Payload for subscription_cancellation_scheduled event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionCancellationScheduledEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "gift_updated" : { "description" : "Triggered when a gift is updated.
", "post" : { "summary" : "Triggered when a gift is updated.", "description" : "Triggered when a gift is updated.
", "operationId" : "onGift_updatedWebhook", "requestBody" : { "description" : "Payload for gift_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GiftUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_trial_extended" : { "description" : "Trial Extension
", "post" : { "summary" : "Trial Extension", "description" : "Trial Extension
", "operationId" : "onSubscription_trial_extendedWebhook", "requestBody" : { "description" : "Payload for subscription_trial_extended event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionTrialExtendedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_renewed" : { "description" : "Triggered when the subscription is renewed from the current term.
", "post" : { "summary" : "Triggered when the subscription is renewed from the current term.", "description" : "Triggered when the subscription is renewed from the current term.
", "operationId" : "onSubscription_renewedWebhook", "requestBody" : { "description" : "Payload for subscription_renewed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionRenewedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "addon_created" : { "description" : "Triggered when an addon is created.
", "post" : { "summary" : "Triggered when an addon is created.", "description" : "Triggered when an addon is created.
", "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.
", "post" : { "summary" : "Triggered when the customer's credit card is expiring soon. Triggered 30 days before the expiry date.", "description" : "Triggered when the customer's credit card is expiring soon. Triggered 30 days before the expiry date.
", "operationId" : "onCard_expiry_reminderWebhook", "requestBody" : { "description" : "Payload for card_expiry_reminder event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CardExpiryReminderEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "token_created" : { "description" : "Triggered when a nonce is created.
", "post" : { "summary" : "Triggered when a nonce is created.", "description" : "Triggered when a nonce is created.
", "operationId" : "onToken_createdWebhook", "requestBody" : { "description" : "Payload for token_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TokenCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "plan_created" : { "description" : "Triggered when a plan is created.
", "post" : { "summary" : "Triggered when a plan is created.", "description" : "Triggered when a plan is created.
", "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.
", "post" : { "summary" : "Triggered when a plan is changed.", "description" : "Triggered when a plan is changed.
", "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.
", "post" : { "summary" : "Triggered when promotional credit is added.", "description" : "Triggered when promotional credit is added.
", "operationId" : "onPromotional_credits_addedWebhook", "requestBody" : { "description" : "Payload for promotional_credits_added event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PromotionalCreditsAddedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_resumption_scheduled" : { "description" : "Triggered when the subscription is scheduled to resume.
", "post" : { "summary" : "Triggered when the subscription is scheduled to resume.", "description" : "Triggered when the subscription is scheduled to resume.
", "operationId" : "onSubscription_resumption_scheduledWebhook", "requestBody" : { "description" : "Payload for subscription_resumption_scheduled event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionResumptionScheduledEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "coupon_codes_deleted" : { "description" : "Triggered when coupon codes are deleted in coupon set.
", "post" : { "summary" : "Triggered when coupon codes are deleted in coupon set.", "description" : "Triggered when coupon codes are deleted in coupon set.
", "operationId" : "onCoupon_codes_deletedWebhook", "requestBody" : { "description" : "Payload for coupon_codes_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CouponCodesDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "card_expired" : { "description" : "Triggered when the card for a customer has expired.
", "post" : { "summary" : "Triggered when the card for a customer has expired.", "description" : "Triggered when the card for a customer has expired.
", "operationId" : "onCard_expiredWebhook", "requestBody" : { "description" : "Payload for card_expired event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CardExpiredEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "credit_note_updated" : { "description" : "Triggered when a credit note is updated.
", "post" : { "summary" : "Triggered when a credit note is updated.", "description" : "Triggered when a credit note is updated.
", "operationId" : "onCredit_note_updatedWebhook", "requestBody" : { "description" : "Payload for credit_note_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreditNoteUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "promotional_credits_deducted" : { "description" : "Triggered when promotional credit is deducted.
", "post" : { "summary" : "Triggered when promotional credit is deducted.", "description" : "Triggered when promotional credit is deducted.
", "operationId" : "onPromotional_credits_deductedWebhook", "requestBody" : { "description" : "Payload for promotional_credits_deducted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PromotionalCreditsDeductedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "payment_source_expired" : { "description" : "Triggered when the payment source for a customer has expired.
", "post" : { "summary" : "Triggered when the payment source for a customer has expired.", "description" : "Triggered when the payment source for a customer has expired.
", "operationId" : "onPayment_source_expiredWebhook", "requestBody" : { "description" : "Payload for payment_source_expired event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentSourceExpiredEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "customer_moved_out" : { "description" : "Triggered when a customer is copied to another site.
", "post" : { "summary" : "Triggered when a customer is copied to another site.", "description" : "Triggered when a customer is copied to another site.
", "operationId" : "onCustomer_moved_outWebhook", "requestBody" : { "description" : "Payload for customer_moved_out event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomerMovedOutEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_paused" : { "description" : "Triggered when the subscription is paused.
", "post" : { "summary" : "Triggered when the subscription is paused.", "description" : "Triggered when the subscription is paused.
", "operationId" : "onSubscription_pausedWebhook", "requestBody" : { "description" : "Payload for subscription_paused event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionPausedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "order_ready_to_process" : { "description" : "Triggered when an order reaches it's order date.
", "post" : { "summary" : "Triggered when an order reaches it's order date.", "description" : "Triggered when an order reaches it's order date.
", "operationId" : "onOrder_ready_to_processWebhook", "requestBody" : { "description" : "Payload for order_ready_to_process event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderReadyToProcessEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "hierarchy_created" : { "description" : "Triggered when a hierarchy is created.
", "post" : { "summary" : "Triggered when a hierarchy is created.", "description" : "Triggered when a hierarchy is created.
", "operationId" : "onHierarchy_createdWebhook", "requestBody" : { "description" : "Payload for hierarchy_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/HierarchyCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "transaction_deleted" : { "description" : "Triggered when a transaction is deleted.
", "post" : { "summary" : "Triggered when a transaction is deleted.", "description" : "Triggered when a transaction is deleted.
", "operationId" : "onTransaction_deletedWebhook", "requestBody" : { "description" : "Payload for transaction_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TransactionDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "credit_note_created" : { "description" : "Triggered when a credit note is created.
", "post" : { "summary" : "Triggered when a credit note is created.", "description" : "Triggered when a credit note is created.
", "operationId" : "onCredit_note_createdWebhook", "requestBody" : { "description" : "Payload for credit_note_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreditNoteCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "coupon_set_created" : { "description" : "Triggered when a coupon set is created.
", "post" : { "summary" : "Triggered when a coupon set is created.", "description" : "Triggered when a coupon set is created.
", "operationId" : "onCoupon_set_createdWebhook", "requestBody" : { "description" : "Payload for coupon_set_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CouponSetCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "transaction_updated" : { "description" : "Triggered when a transaction is updated. E.g. (1) When a transaction is removed, (2) or when an excess payment is applied on an invoice, (3) or when amount_capturable gets updated.
", "post" : { "summary" : "Triggered when a transaction is updated. E.g. (1) When a transaction is removed, (2) or when an excess payment is applied on an invoice, (3) or when amount_capturable gets updated.", "description" : "Triggered when a transaction is updated. E.g. (1) When a transaction is removed, (2) or when an excess payment is applied on an invoice, (3) or when amount_capturable gets updated.
", "operationId" : "onTransaction_updatedWebhook", "requestBody" : { "description" : "Payload for transaction_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TransactionUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "payment_intent_updated" : { "description" : "Triggered when a payment intent is updated.
", "post" : { "summary" : "Triggered when a payment intent is updated.", "description" : "Triggered when a payment intent is updated.
", "operationId" : "onPayment_intent_updatedWebhook", "requestBody" : { "description" : "Payload for payment_intent_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentIntentUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "mrr_updated" : { "description" : "Triggered when either of MRR or CMRR is changed.
", "post" : { "summary" : "Triggered when either of MRR or CMRR is changed.", "description" : "Triggered when either of MRR or CMRR is changed.
", "operationId" : "onMrr_updatedWebhook", "requestBody" : { "description" : "Payload for mrr_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MrrUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "order_resent" : { "description" : "Triggered when an order is resent.
", "post" : { "summary" : "Triggered when an order is resent.", "description" : "Triggered when an order is resent.
", "operationId" : "onOrder_resentWebhook", "requestBody" : { "description" : "Payload for order_resent event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderResentEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "unbilled_charges_invoiced" : { "description" : "Triggered when unbilled charges are invoiced
", "post" : { "summary" : "Triggered when unbilled charges are invoiced", "description" : "Triggered when unbilled charges are invoiced
", "operationId" : "onUnbilled_charges_invoicedWebhook", "requestBody" : { "description" : "Payload for unbilled_charges_invoiced event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UnbilledChargesInvoicedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "tax_withheld_recorded" : { "description" : "Triggered when a tax withheld is recorded for an invoice.
", "post" : { "summary" : "Triggered when a tax withheld is recorded for an invoice.", "description" : "Triggered when a tax withheld is recorded for an invoice.
", "operationId" : "onTax_withheld_recordedWebhook", "requestBody" : { "description" : "Payload for tax_withheld_recorded event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxWithheldRecordedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "coupon_codes_updated" : { "description" : "Triggered when coupon codes are updated in coupon set.
", "post" : { "summary" : "Triggered when coupon codes are updated in coupon set.", "description" : "Triggered when coupon codes are updated in coupon set.
", "operationId" : "onCoupon_codes_updatedWebhook", "requestBody" : { "description" : "Payload for coupon_codes_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CouponCodesUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "virtual_bank_account_updated" : { "description" : "Triggered when the virtual bank account is updated.
", "post" : { "summary" : "Triggered when the virtual bank account is updated.", "description" : "Triggered when the virtual bank account is updated.
", "operationId" : "onVirtual_bank_account_updatedWebhook", "requestBody" : { "description" : "Payload for virtual_bank_account_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VirtualBankAccountUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "contract_term_created" : { "description" : "Triggered when contract term is created.
", "post" : { "summary" : "Triggered when contract term is created.", "description" : "Triggered when contract term is created.
", "operationId" : "onContract_term_createdWebhook", "requestBody" : { "description" : "Payload for contract_term_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ContractTermCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_changed" : { "description" : "Triggered when the subscription's recurring items are changed.
", "post" : { "summary" : "Triggered when the subscription's recurring items are changed.", "description" : "Triggered when the subscription's recurring items are changed.
", "operationId" : "onSubscription_changedWebhook", "requestBody" : { "description" : "Payload for subscription_changed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionChangedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "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.
", "post" : { "summary" : "Triggered when contract term is cancelled.", "description" : "Triggered when contract term is cancelled.
", "operationId" : "onContract_term_cancelledWebhook", "requestBody" : { "description" : "Payload for contract_term_cancelled event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ContractTermCancelledEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "contract_term_renewed" : { "description" : "Triggered when a contract term is renewed.
", "post" : { "summary" : "Triggered when a contract term is renewed.", "description" : "Triggered when a contract term is renewed.
", "operationId" : "onContract_term_renewedWebhook", "requestBody" : { "description" : "Payload for contract_term_renewed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ContractTermRenewedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "invoice_deleted" : { "description" : "Event triggered when an invoice is deleted.
", "post" : { "summary" : "Event triggered when an invoice is deleted.", "description" : "Event triggered when an invoice is deleted.
", "operationId" : "onInvoice_deletedWebhook", "requestBody" : { "description" : "Payload for invoice_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/InvoiceDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "payment_failed" : { "description" : "Triggered when the payment collection fails.
", "post" : { "summary" : "Triggered when the payment collection fails.", "description" : "Triggered when the payment collection fails.
", "operationId" : "onPayment_failedWebhook", "requestBody" : { "description" : "Payload for payment_failed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentFailedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "credit_note_deleted" : { "description" : "Triggered when a credit note is deleted.
", "post" : { "summary" : "Triggered when a credit note is deleted.", "description" : "Triggered when a credit note is deleted.
", "operationId" : "onCredit_note_deletedWebhook", "requestBody" : { "description" : "Payload for credit_note_deleted event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreditNoteDeletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "tax_withheld_refunded" : { "description" : "Triggered when a tax withheld is refunded.
", "post" : { "summary" : "Triggered when a tax withheld is refunded.", "description" : "Triggered when a tax withheld is refunded.
", "operationId" : "onTax_withheld_refundedWebhook", "requestBody" : { "description" : "Payload for tax_withheld_refunded event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxWithheldRefundedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "contract_term_completed" : { "description" : "Triggered when contract term is completed.
", "post" : { "summary" : "Triggered when contract term is completed.", "description" : "Triggered when contract term is completed.
", "operationId" : "onContract_term_completedWebhook", "requestBody" : { "description" : "Payload for contract_term_completed event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ContractTermCompletedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "card_updated" : { "description" : "Triggered when the card is updated for a customer.
", "post" : { "summary" : "Triggered when the card is updated for a customer.", "description" : "Triggered when the card is updated for a customer.
", "operationId" : "onCard_updatedWebhook", "requestBody" : { "description" : "Payload for card_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CardUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "customer_created" : { "description" : "Triggered when a customer is created.
", "post" : { "summary" : "Triggered when a customer is created.", "description" : "Triggered when a customer is created.
", "operationId" : "onCustomer_createdWebhook", "requestBody" : { "description" : "Payload for customer_created event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomerCreatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "pending_invoice_updated" : { "description" : "Triggered when you make the following changes to a pending invoice: add a charge, add a non-recurring addon, or delete a line item.
", "post" : { "summary" : "Triggered when you make the following changes to the invoice - void, delete, invoice address update, status change, payment changes - apply payment / remove payment, credit apply/remove, credit note creation, and so on. 'Invoice_updated' is triggered for all changes made to the invoice except for the changes which trigger 'pending_invoice_updated'.", "description" : "Triggered when you make the following changes to a pending invoice: add a charge, add a non-recurring addon, or delete a line item.
", "operationId" : "onPending_invoice_updatedWebhook", "requestBody" : { "description" : "Payload for pending_invoice_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PendingInvoiceUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "quote_updated" : { "description" : "Triggered when a quote is updated.
", "post" : { "summary" : "Triggered when a quote is updated.", "description" : "Triggered when a quote is updated.
", "operationId" : "onQuote_updatedWebhook", "requestBody" : { "description" : "Payload for quote_updated event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/QuoteUpdatedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "subscription_renewal_reminder" : { "description" : "Triggered 3 days before each subscription's renewal.
", "post" : { "summary" : "Triggered 3 days before each subscription's renewal.", "description" : "Triggered 3 days before each subscription's renewal.
", "operationId" : "onSubscription_renewal_reminderWebhook", "requestBody" : { "description" : "Payload for subscription_renewal_reminder event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionRenewalReminderEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } }, "payment_source_updated" : { "description" : "Triggered when the payment source is updated and also when a role is assigned to it.
", "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.
", "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.
", "post" : { "summary" : "Triggered when a authorization transaction is voided. Authorization can be voided either manually or when blocked funds are released by the gateway after a certain period of time.", "description" : "Triggered when a authorization transaction is voided. Authorization can be voided either manually or when blocked funds are released by the gateway after a certain period of time.
", "operationId" : "onAuthorization_voidedWebhook", "requestBody" : { "description" : "Payload for authorization_voided event", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationVoidedEvent" } } } }, "responses" : { "200" : { "description" : "Webhook received successfully" } }, "deprecated" : false } } } }