From fbd261f5383317cdc98d00d448ba038cc0659df1 Mon Sep 17 00:00:00 2001 From: cb-alish Date: Tue, 21 Jul 2026 12:10:14 +0530 Subject: [PATCH] Updating Open API Specs Jul 21st, 2026 --- spec/chargebee_api_v1_spec.json | 50 +- spec/chargebee_api_v1_spec.yaml | 56 +- spec/chargebee_api_v2_pc_v1_spec.json | 1207 +++-- spec/chargebee_api_v2_pc_v1_spec.yaml | 1375 ++++-- spec/chargebee_api_v2_pc_v2_spec.json | 6279 ++++++++++++++++++------- spec/chargebee_api_v2_pc_v2_spec.yaml | 4679 ++++++++++++++---- spec/chargebee_sdk_spec.json | 4291 +++++++++++++---- spec/chargebee_sdk_spec.yaml | 3956 +++++++++++++--- 8 files changed, 16725 insertions(+), 5168 deletions(-) diff --git a/spec/chargebee_api_v1_spec.json b/spec/chargebee_api_v1_spec.json index 782471c0..f66a1161 100644 --- a/spec/chargebee_api_v1_spec.json +++ b/spec/chargebee_api_v1_spec.json @@ -7,10 +7,10 @@ "url" : "https://www.chargebee.com", "email" : "support@chargebee.com" }, - "version" : "2026-06-12.a49b34edd262e3e190bd6d8616ff9e401c37bd21", - "x-cb-api-version" : 1, + "version" : "2026-07-21.2a6a65b3e1a8ff29840466a7bfdb5cdd778d0634", "x-cb-product-catalog-version" : 1, - "x-generated-on" : 1781239677988 + "x-cb-api-version" : 1, + "x-generated-on" : 1784611157092 }, "servers" : [ { "url" : "{protocol}://{site}.{environment}:{port}/api/v1", @@ -31909,48 +31909,6 @@ "required" : [ "label", "subscription_id" ], "example" : null }, - "ApiKey" : { - "type" : "object", - "properties" : { - "key_name" : { - "type" : "string", - "deprecated" : false, - "maxLength" : 50, - "example" : null - }, - "key" : { - "type" : "string", - "deprecated" : false, - "maxLength" : 250, - "example" : null - }, - "created_at" : { - "type" : "integer", - "format" : "unix-time", - "deprecated" : false, - "example" : null - }, - "status" : { - "type" : "string", - "deprecated" : false, - "enum" : [ "enabled", "disabled" ], - "example" : null - }, - "roles" : { - "type" : "array", - "deprecated" : false, - "items" : { - "type" : "string", - "deprecated" : false, - "enum" : [ "full_access", "update_access", "read_only_access", "read_transactional_data", "read_product_configuration", "publishable", "publishable_extended" ], - "example" : null - }, - "example" : null - } - }, - "required" : [ "created_at", "key_name" ], - "example" : null - }, "ApiVersion" : { "type" : "string", "default" : "v1", @@ -33882,7 +33840,7 @@ }, "HostedPage" : { "type" : "object", - "description" : "Hosted pages are the easiest and most secure way to integrate chargebee with your website. By using hosted pages, you can avoid the sensitive card information passing through your server and be compliant with most of the PCI DSS requirements.\n\nWhen you request for a hosted page, a **secure** and **unique URL** will be returned which you could either embed or redirect depending upon the embed parameter value that you had passed.\n\nSpecifying **\"embed\"** parameter as **true** allows you to embed the \"hosted page\" in an iframe in your own website. This helps you provide the best experience to your user as they do not have to leave your website to provide card information. There are a few limitations:\n\n* Your site URL must be embedded with HTTPS.\n* Set the appropriate height and width for the iframe to avoid scrolling.\n\nTo use the hosted pages, you must configure **Redirect URL** in the Chargebee web interface under **Hosted Pages Settings** \\> **Configuration**. The configured redirect URL will be called with the following parameters after user had submitted the page.\n\n* **id** - unique identifier of the hosted page resource\n* **state** - succeeded, failed or cancelled\n\nAfter the **Redirect URL** is called by Chargebee with the above parameters, the details of the hosted page can be fetched using [Retrieve a hosted page](/docs/api/v1/hosted_pages/retrieve-a-hosted-page) API. The **content** attribute will have the details about the customer, subscription, card and invoice based on the type of the hosted page.\n\n[Checkout New Subscription](/docs/api/v1/hosted_pages/checkout-new-subscription):\n\n* [Customer](/docs/api/v1/customers/customer-object) - The details about the new customer created.\n* [Subscription](/docs/api/v1/subscriptions/subscription-object) - The details about the new subscription created.\n* [Card](/docs/api/v1/cards/card-object) - The details about the card provided while subscribing.\n* [Invoice](/docs/api/v1/invoices/invoice-object) - The details about the invoice, if one is generated.\n\n[Checkout Existing Subscription](/docs/api/v1/hosted_pages/checkout-existing-subscription):\n\n* [Customer](/docs/api/v1/customers/customer-object) - The updated details of the customer.\n* [Subscription](/docs/api/v1/subscriptions/subscription-object) - The updated details of the subscription.\n* [Card](/docs/api/v1/cards/card-object) - The details about the card provided while subscribing.\n* [Invoice](/docs/api/v1/invoices/invoice-object) - The details about the invoice, if one is generated.\n\n[Update Payment Method](/docs/api/v1/hosted_pages/update-payment-method):\n\n* [Customer](/docs/api/v1/customers/customer-object) - The details about the customer for whom the card was updated.\n* [Card](/docs/api/v1/cards/card-object) - The details about the updated card. It will be present only if the type of payment method is card.\n\nWhen an embedded hosted page is cancelled by your end user, the **content** attribute will have the unmodified details of customer, subscription and card resources.\n", + "description" : "Hosted pages are the easiest and most secure way to integrate chargebee with your website. By using hosted pages, you can avoid the sensitive card information passing through your server and be compliant with most of the PCI DSS requirements.\n\nWhen you request for a hosted page, a **secure** and **unique URL** will be returned which you could either embed or redirect depending upon the embed parameter value that you had passed.\n\nSpecifying **\"embed\"** parameter as **true** allows you to embed the \"hosted page\" in an iframe in your own website. This helps you provide the best experience to your user as they do not have to leave your website to provide card information. There are a few limitations:\n\n* Your site URL must be embedded with HTTPS.\n* Set the appropriate height and width for the iframe to avoid scrolling.\n\nTo use the hosted pages, you must configure **Redirect URL** in the Chargebee web interface under **Hosted Pages Settings** \\> **Configuration**. The configured redirect URL will be called with the following parameters after user had submitted the page.\n\n* **id** - unique identifier of the hosted page resource\n* **state** - succeeded, failed or cancelled\n\nAfter the **Redirect URL** is called by Chargebee with the above parameters, the details of the hosted page can be fetched using [Retrieve a hosted page](/docs/api/v1/hosted_pages/retrieve-a-hosted-page) API. The **content** attribute will have the details about the customer, subscription, card and invoice based on the type of the hosted page.\n\n[Checkout New Subscription](/docs/api/v1/hosted_pages/checkout-new-subscription):\n\n* [Customer](/docs/api/v1/customers/customer-object) - The details about the new customer created.\n* [Subscription](/docs/api/v1/subscriptions/subscription-object) - The details about the new subscription created.\n* [Card](/docs/api/v1/cards/card-object) - The details about the card provided while subscribing.\n* [Invoice](/docs/api/v1/invoices/invoice-object) - The details about the invoice, if one is generated.\n\n[Checkout Existing Subscription](/docs/api/v1/hosted_pages/checkout-existing-subscription):\n\n* [Customer](/docs/api/v1/customers/customer-object) - The updated details of the customer.\n* [Subscription](/docs/api/v1/subscriptions/subscription-object) - The updated details of the subscription.\n* [Card](/docs/api/v1/cards/card-object) - The details about the card provided while subscribing.\n* [Invoice](/docs/api/v1/invoices/invoice-object) - The details about the invoice, if one is generated.\n\nWhen an embedded hosted page is cancelled by your end user, the **content** attribute will have the unmodified details of customer, subscription and card resources.\n", "properties" : { "id" : { "type" : "string", diff --git a/spec/chargebee_api_v1_spec.yaml b/spec/chargebee_api_v1_spec.yaml index 95654df3..9999f668 100644 --- a/spec/chargebee_api_v1_spec.yaml +++ b/spec/chargebee_api_v1_spec.yaml @@ -5,10 +5,10 @@ info: name: Chargebee Support url: https://www.chargebee.com email: support@chargebee.com - version: 2026-06-12.a49b34edd262e3e190bd6d8616ff9e401c37bd21 - x-cb-api-version: 1 + version: 2026-07-21.2a6a65b3e1a8ff29840466a7bfdb5cdd778d0634 x-cb-product-catalog-version: 1 - x-generated-on: 1781239677988 + x-cb-api-version: 1 + x-generated-on: 1784611157092 servers: - url: "{protocol}://{site}.{environment}:{port}/api/v1" variables: @@ -30396,51 +30396,6 @@ components: - label - subscription_id example: null - ApiKey: - type: object - properties: - key_name: - type: string - deprecated: false - maxLength: 50 - example: null - key: - type: string - deprecated: false - maxLength: 250 - example: null - created_at: - type: integer - format: unix-time - deprecated: false - example: null - status: - type: string - deprecated: false - enum: - - enabled - - disabled - example: null - roles: - type: array - deprecated: false - items: - type: string - deprecated: false - enum: - - full_access - - update_access - - read_only_access - - read_transactional_data - - read_product_configuration - - publishable - - publishable_extended - example: null - example: null - required: - - created_at - - key_name - example: null ApiVersion: type: string default: v1 @@ -33334,11 +33289,6 @@ components: * [Card](/docs/api/v1/cards/card-object) - The details about the card provided while subscribing. * [Invoice](/docs/api/v1/invoices/invoice-object) - The details about the invoice, if one is generated. - [Update Payment Method](/docs/api/v1/hosted_pages/update-payment-method): - - * [Customer](/docs/api/v1/customers/customer-object) - The details about the customer for whom the card was updated. - * [Card](/docs/api/v1/cards/card-object) - The details about the updated card. It will be present only if the type of payment method is card. - When an embedded hosted page is cancelled by your end user, the **content** attribute will have the unmodified details of customer, subscription and card resources. properties: id: diff --git a/spec/chargebee_api_v2_pc_v1_spec.json b/spec/chargebee_api_v2_pc_v1_spec.json index fcfe8627..b9bba460 100644 --- a/spec/chargebee_api_v2_pc_v1_spec.json +++ b/spec/chargebee_api_v2_pc_v1_spec.json @@ -7,10 +7,10 @@ "url" : "https://www.chargebee.com", "email" : "support@chargebee.com" }, - "version" : "2026-06-12.a49b34edd262e3e190bd6d8616ff9e401c37bd21", + "version" : "2026-07-21.2a6a65b3e1a8ff29840466a7bfdb5cdd778d0634", "x-cb-api-version" : 2, "x-cb-product-catalog-version" : 1, - "x-generated-on" : 1781239687838 + "x-generated-on" : 1784611165580 }, "servers" : [ { "url" : "{protocol}://{site}.{environment}:{port}/api/v2", @@ -820,7 +820,7 @@ "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" ], + "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" ], "example" : null }, "reference_id" : { @@ -1970,7 +1970,7 @@ }, { "name" : "auto_close_invoices", "in" : "query", - "description" : "

optional, boolean filter

\n

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.\nPossible values are : true, false

\n

Supported operators :\nis

\n

Example →\nauto_close_invoices[is] = "true"

", + "description" : "

optional, boolean filter

\n

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.\nPossible values are : true, false

\n

Supported operators :\nis

\n

Example →\nauto_close_invoices[is] = "true"

", "required" : false, "deprecated" : false, "style" : "deepObject", @@ -2094,6 +2094,26 @@ } } } + }, { + "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" : { @@ -3039,7 +3059,7 @@ "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\\* go_pay -\n\nPayments made via GoPay\n\\* google_pay -\n\nPayments made via Google Pay.\n\\* after_pay -\n\nPayments made via Afterpay\n\\* pix -\n\nPayments made via Pix\n\\* pay_by_bank -\n\nPay By Bank\n\\* sofort -\n\nPayments made via Sofort.\n\\* twint -\n\nPayments made via Twint\n\\* netbanking_emandates -\n\nNetbanking (eMandates) Payments.\n\\* apple_pay -\n\nPayments made via Apple Pay.\n\\* unionpay -\n\nPayments made via UnionPay.\n\\* giropay -\n\nPayments made via giropay.\n\\* direct_debit -\n\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\\* upi -\n\nUPI Payments.\n\\* revolut_pay -\n\nPayments made via Revolut Pay.\n\\* stablecoin -\n\nPayments made via Stablecoin.\n\\* alipay -\n\nPayments made via Alipay. \nThis payment source is deprecated.\n\\* payme -\n\nPayments made via PayMe\n\\* pay_to -\n\nPayments made via PayTo\n\\* pay_co -\n\nPayments made via PayCo\n\\* kakao_pay -\n\nPayments made via Kakao Pay.\n\\* wechat_pay -\n\nPayments made via WeChat Pay. \nThis payment source is deprecated.\n\\* sepa_instant_transfer -\n\nPayments made via Sepa Instant Transfer\n\\* dotpay -\n\nPayments made via Dotpay.\n\\* klarna -\n\nPayments made via Klarna.\n\\* paypal_express_checkout -\n\nPayments made via PayPal Express Checkout.\n\\* ideal -\n\nPayments made via iDEAL.\n\\* electronic_payment_standard -\n\nElectronic Payment Standard\n\\* generic -\n\nPayments made via Generic Payment Method.\n\\* klarna_pay_now -\n\nPayments made via Klarna Pay Now\n\\* faster_payments -\n\nPayments made via Faster Payments\n\\* swish -\n\nPayments made via Swish\n\\* venmo -\n\nPayments made via Venmo\n\\* payconiq_by_bancontact -\n\nPayments made via Payconiq by Bancontact.\n\\* naver_pay -\n\nPayments made via Naver Pay.\n\\* automated_bank_transfer -\n\nRepresents virtual bank account using which the payment will be done.\n\\* amazon_payments -\n\nPayments made via Amazon Payments.\n\\* gcash - \\* card -\n\nCard based payment including credit cards and debit cards. Details about the card can be obtained from the card resource.\n\\* online_banking_poland -\n\nPayments made via Online Banking Poland\n\\* trustly -\n\nTrustly\n\\* kbc_payment_button -\n\nKBC Payment Button\n\\* alipay_hk - \\* 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" ], + "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" ], "example" : null }, "gateway_account_id" : { @@ -3110,7 +3130,7 @@ "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\\* card -\n\ncard\n\\* twint -\n\nPayments made via Twint\n\\* dotpay -\n\ndotpay\n\\* faster_payments -\n\nFaster Payments\n\\* upi -\n\nupi\n\\* kbc_payment_button -\n\nKBC Payment Button\n\\* klarna -\n\nPayments made via Klarna.\n\\* payme -\n\nPayments made via PayMe\n\\* google_pay -\n\ngoogle_pay\n\\* paypal_express_checkout -\n\npaypal_express_checkout\n\\* pix -\n\nPix\n\\* klarna_pay_now -\n\nKlarna Pay Now\n\\* ideal -\n\nideal\n\\* boleto -\n\nboleto\n\\* wechat_pay -\n\nPayments made via WeChat Pay.\n\\* after_pay -\n\nPayments made via Afterpay\n\\* grab_pay -\n\nPayments made via GrabPay\n\\* direct_debit -\n\ndirect_debit\n\\* sepa_instant_transfer -\n\nSepa Instant Transfer\n\\* bancontact -\n\nbancontact\n\\* kakao_pay -\n\nPayments made via Kakao Pay.\n\\* south_korean_cards - \\* swish -\n\nPayments made via Swish\n\\* go_pay -\n\nPayments made via GoPay\n\\* trustly -\n\nTrustly\n\\* naver_pay -\n\nPayments made via Naver Pay.\n\\* stablecoin -\n\nPayments made via Stablecoin.\n\\* venmo -\n\nVenmo\n\\* alipay -\n\nPayments made via Alipay.\n\\* pay_to -\n\nPayTo\n\\* pay_co -\n\nPayments made via PayCo\n\\* cash_app_pay -\n\nPayments made via Cash App Pay.\n\\* alipay_hk - \\* netbanking_emandates -\n\nnetbanking_emandates\n\\* paypay - \\* payconiq_by_bancontact -\n\nPayments made via Payconiq by Bancontact.\n\\* electronic_payment_standard -\n\nElectronic Payment Standard\n\\* pay_by_bank -\n\nPay By Bank\n\\* apple_pay -\n\napple_pay\n\\* online_banking_poland -\n\nOnline Banking Poland\n\\* gcash - \\* giropay -\n\ngiropay\n\\* sofort -\n\nsofort\n\\* amazon_payments -\n\nAmazon Payments\n\\* revolut_pay -\n\nPayments made via Revolut Pay.\n", - "enum" : [ "card", "ideal", "sofort", "bancontact", "google_pay", "dotpay", "giropay", "apple_pay", "upi", "netbanking_emandates", "paypal_express_checkout", "direct_debit", "boleto", "venmo", "amazon_payments", "pay_to", "faster_payments", "sepa_instant_transfer", "klarna_pay_now", "online_banking_poland", "payconiq_by_bancontact", "electronic_payment_standard", "kbc_payment_button", "pay_by_bank", "trustly", "stablecoin", "kakao_pay", "naver_pay", "revolut_pay", "cash_app_pay", "wechat_pay", "alipay", "twint", "go_pay", "grab_pay", "pay_co", "after_pay", "swish", "payme", "pix", "klarna", "alipay_hk", "paypay", "gcash", "south_korean_cards" ], + "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" ], "example" : null }, "reference_id" : { @@ -5589,7 +5609,7 @@ "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\\* card -\n\ncard\n\\* twint -\n\nPayments made via Twint\n\\* swish -\n\nPayments made via Swish\n\\* dotpay -\n\ndotpay\n\\* faster_payments -\n\nFaster Payments\n\\* upi -\n\nupi\n\\* kbc_payment_button -\n\nKBC Payment Button\n\\* klarna -\n\nPayments made via Klarna.\n\\* payme -\n\nPayments made via PayMe\n\\* go_pay -\n\nPayments made via GoPay\n\\* google_pay -\n\ngoogle_pay\n\\* trustly -\n\nTrustly\n\\* naver_pay -\n\nPayments made via Naver Pay.\n\\* stablecoin -\n\nPayments made via Stablecoin.\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\\* ideal -\n\nideal\n\\* pay_to -\n\nPayTo\n\\* boleto -\n\nboleto\n\\* pay_co -\n\nPayments made via PayCo\n\\* wechat_pay -\n\nPayments made via WeChat Pay.\n\\* cash_app_pay -\n\nPayments made via Cash App Pay.\n\\* alipay_hk - \\* 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\\* electronic_payment_standard -\n\nElectronic Payment Standard\n\\* direct_debit -\n\ndirect_debit\n\\* sepa_instant_transfer -\n\nSepa Instant Transfer\n\\* bancontact -\n\nbancontact\n\\* pay_by_bank -\n\nPay By Bank\n\\* apple_pay -\n\napple_pay\n\\* online_banking_poland -\n\nOnline Banking Poland\n\\* gcash - \\* giropay -\n\ngiropay\n\\* sofort -\n\nsofort\n\\* amazon_payments -\n\nAmazon Payments\n\\* kakao_pay -\n\nPayments made via Kakao Pay.\n\\* south_korean_cards - \\* revolut_pay -\n\nPayments made via Revolut Pay.\n", - "enum" : [ "card", "ideal", "sofort", "bancontact", "google_pay", "dotpay", "giropay", "apple_pay", "upi", "netbanking_emandates", "paypal_express_checkout", "direct_debit", "boleto", "venmo", "amazon_payments", "pay_to", "faster_payments", "sepa_instant_transfer", "klarna_pay_now", "online_banking_poland", "payconiq_by_bancontact", "electronic_payment_standard", "kbc_payment_button", "pay_by_bank", "trustly", "stablecoin", "kakao_pay", "naver_pay", "revolut_pay", "cash_app_pay", "wechat_pay", "alipay", "twint", "go_pay", "grab_pay", "pay_co", "after_pay", "swish", "payme", "pix", "klarna", "alipay_hk", "paypay", "gcash", "south_korean_cards" ], + "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" ], "example" : null }, "reference_id" : { @@ -7007,7 +7027,7 @@ "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 -\n\nOnline Banking Poland\n\\* 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" ], + "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" ], "example" : null }, "reference_id" : { @@ -9385,7 +9405,7 @@ "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\\* go_pay -\n\nPayments made via GoPay\n\\* google_pay -\n\nPayments made via Google Pay.\n\\* after_pay -\n\nPayments made via Afterpay\n\\* pix -\n\nPayments made via Pix\n\\* pay_by_bank -\n\nPay By Bank\n\\* sofort -\n\nPayments made via Sofort.\n\\* twint -\n\nPayments made via Twint\n\\* netbanking_emandates -\n\nNetbanking (eMandates) Payments.\n\\* apple_pay -\n\nPayments made via Apple Pay.\n\\* unionpay -\n\nPayments made via UnionPay.\n\\* giropay -\n\nPayments made via giropay.\n\\* direct_debit -\n\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\\* upi -\n\nUPI Payments.\n\\* revolut_pay -\n\nPayments made via Revolut Pay.\n\\* stablecoin -\n\nPayments made via Stablecoin.\n\\* alipay -\n\nPayments made via Alipay. \nThis payment source is deprecated.\n\\* payme -\n\nPayments made via PayMe\n\\* pay_to -\n\nPayments made via PayTo\n\\* pay_co -\n\nPayments made via PayCo\n\\* kakao_pay -\n\nPayments made via Kakao Pay.\n\\* wechat_pay -\n\nPayments made via WeChat Pay. \nThis payment source is deprecated.\n\\* sepa_instant_transfer -\n\nPayments made via Sepa Instant Transfer\n\\* dotpay -\n\nPayments made via Dotpay.\n\\* klarna -\n\nPayments made via Klarna.\n\\* paypal_express_checkout -\n\nPayments made via PayPal Express Checkout.\n\\* ideal -\n\nPayments made via iDEAL.\n\\* electronic_payment_standard -\n\nElectronic Payment Standard\n\\* generic -\n\nPayments made via Generic Payment Method.\n\\* klarna_pay_now -\n\nPayments made via Klarna Pay Now\n\\* faster_payments -\n\nPayments made via Faster Payments\n\\* swish -\n\nPayments made via Swish\n\\* venmo -\n\nPayments made via Venmo\n\\* payconiq_by_bancontact -\n\nPayments made via Payconiq by Bancontact.\n\\* naver_pay -\n\nPayments made via Naver Pay.\n\\* automated_bank_transfer -\n\nRepresents virtual bank account using which the payment will be done.\n\\* amazon_payments -\n\nPayments made via Amazon Payments.\n\\* gcash - \\* card -\n\nCard based payment including credit cards and debit cards. Details about the card can be obtained from the card resource.\n\\* online_banking_poland - \\* trustly -\n\nTrustly\n\\* kbc_payment_button -\n\nKBC Payment Button\n\\* alipay_hk - \\* 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" ], + "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" ], "example" : null }, "gateway_account_id" : { @@ -10069,7 +10089,7 @@ }, "/subscriptions/{subscription-id}/import_unbilled_charges" : { "post" : { - "summary" : "Import Unbilled Charges", + "summary" : "Import unbilled charges", "description" : "Imports unbilled charges into Chargebee.\n", "operationId" : "import_unbilled_charges", "parameters" : [ { @@ -11685,7 +11705,7 @@ "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\\* go_pay -\n\nPayments made via GoPay\n\\* google_pay -\n\nPayments made via Google Pay.\n\\* after_pay -\n\nPayments made via Afterpay\n\\* pix -\n\nPayments made via Pix\n\\* pay_by_bank -\n\nPay By Bank\n\\* sofort -\n\nPayments made via Sofort.\n\\* twint -\n\nPayments made via Twint\n\\* netbanking_emandates -\n\nNetbanking (eMandates) Payments.\n\\* apple_pay -\n\nPayments made via Apple Pay.\n\\* unionpay -\n\nPayments made via UnionPay.\n\\* giropay -\n\nPayments made via giropay.\n\\* direct_debit -\n\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\\* upi -\n\nUPI Payments.\n\\* revolut_pay -\n\nPayments made via Revolut Pay.\n\\* stablecoin -\n\nPayments made via Stablecoin.\n\\* alipay -\n\nPayments made via Alipay. \nThis payment source is deprecated.\n\\* payme -\n\nPayments made via PayMe\n\\* pay_to -\n\nPayments made via PayTo\n\\* pay_co -\n\nPayments made via PayCo\n\\* kakao_pay -\n\nPayments made via Kakao Pay.\n\\* wechat_pay -\n\nPayments made via WeChat Pay. \nThis payment source is deprecated.\n\\* sepa_instant_transfer -\n\nPayments made via Sepa Instant Transfer\n\\* dotpay -\n\nPayments made via Dotpay.\n\\* klarna -\n\nPayments made via Klarna.\n\\* paypal_express_checkout -\n\nPayments made via PayPal Express Checkout.\n\\* ideal -\n\nPayments made via iDEAL.\n\\* electronic_payment_standard -\n\nElectronic Payment Standard\n\\* generic -\n\nPayments made via Generic Payment Method.\n\\* klarna_pay_now -\n\nPayments made via Klarna Pay Now\n\\* faster_payments -\n\nPayments made via Faster Payments\n\\* swish -\n\nPayments made via Swish\n\\* venmo -\n\nPayments made via Venmo\n\\* payconiq_by_bancontact -\n\nPayments made via Payconiq by Bancontact.\n\\* naver_pay -\n\nPayments made via Naver Pay.\n\\* automated_bank_transfer -\n\nRepresents virtual bank account using which the payment will be done.\n\\* amazon_payments -\n\nPayments made via Amazon Payments.\n\\* gcash - \\* card -\n\nCard based payment including credit cards and debit cards. Details about the card can be obtained from the card resource.\n\\* online_banking_poland -\n\nPayments made via Online Banking Poland\n\\* trustly -\n\nTrustly\n\\* kbc_payment_button -\n\nKBC Payment Button\n\\* alipay_hk - \\* 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" ], + "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" ], "example" : null }, "gateway_account_id" : { @@ -11756,7 +11776,7 @@ "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\\* card -\n\ncard\n\\* twint -\n\nPayments made via Twint\n\\* dotpay -\n\ndotpay\n\\* faster_payments - \\* upi -\n\nupi\n\\* kbc_payment_button -\n\nKBC Payment Button\n\\* klarna -\n\nPayments made via Klarna.\n\\* payme -\n\nPayments made via PayMe\n\\* google_pay -\n\ngoogle_pay\n\\* paypal_express_checkout -\n\npaypal_express_checkout\n\\* pix -\n\nPix\n\\* klarna_pay_now -\n\nKlarna Pay Now\n\\* ideal -\n\nideal\n\\* boleto -\n\nboleto\n\\* wechat_pay -\n\nPayments made via WeChat Pay.\n\\* after_pay -\n\nPayments made via Afterpay\n\\* grab_pay -\n\nPayments made via GrabPay\n\\* direct_debit -\n\ndirect_debit\n\\* sepa_instant_transfer - \\* bancontact -\n\nbancontact\n\\* kakao_pay -\n\nPayments made via Kakao Pay.\n\\* south_korean_cards - \\* swish -\n\nPayments made via Swish\n\\* go_pay -\n\nPayments made via GoPay\n\\* trustly -\n\nTrustly\n\\* naver_pay -\n\nPayments made via Naver Pay.\n\\* stablecoin -\n\nPayments made via Stablecoin.\n\\* venmo - \\* alipay -\n\nPayments made via Alipay.\n\\* pay_to - \\* pay_co -\n\nPayments made via PayCo\n\\* cash_app_pay -\n\nPayments made via Cash App Pay.\n\\* alipay_hk - \\* netbanking_emandates -\n\nnetbanking_emandates\n\\* paypay - \\* payconiq_by_bancontact -\n\nPayments made via Payconiq by Bancontact.\n\\* electronic_payment_standard -\n\nElectronic Payment Standard\n\\* pay_by_bank -\n\nPay By Bank\n\\* apple_pay -\n\napple_pay\n\\* online_banking_poland -\n\nOnline Banking Poland\n\\* gcash - \\* giropay -\n\ngiropay\n\\* sofort -\n\nsofort\n\\* amazon_payments -\n\nAmazon Payments\n\\* revolut_pay -\n\nPayments made via Revolut Pay.\n", - "enum" : [ "card", "ideal", "sofort", "bancontact", "google_pay", "dotpay", "giropay", "apple_pay", "upi", "netbanking_emandates", "paypal_express_checkout", "direct_debit", "boleto", "venmo", "amazon_payments", "pay_to", "faster_payments", "sepa_instant_transfer", "klarna_pay_now", "online_banking_poland", "payconiq_by_bancontact", "electronic_payment_standard", "kbc_payment_button", "pay_by_bank", "trustly", "stablecoin", "kakao_pay", "naver_pay", "revolut_pay", "cash_app_pay", "wechat_pay", "alipay", "twint", "go_pay", "grab_pay", "pay_co", "after_pay", "swish", "payme", "pix", "klarna", "alipay_hk", "paypay", "gcash", "south_korean_cards" ], + "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" ], "example" : null }, "reference_id" : { @@ -12886,7 +12906,7 @@ }, "/subscriptions/{subscription-id}/override_billing_profile" : { "post" : { - "summary" : "Override Billing Profile", + "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" : [ { @@ -14157,7 +14177,7 @@ }, "/subscriptions/{subscription-id}/edit_advance_invoice_schedule" : { "post" : { - "summary" : "Edit Advance Invoice Schedule", + "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" : [ { @@ -17692,7 +17712,7 @@ "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\\* direct_debit -\n\nRepresents bank account for which the direct debit or ACH agreement/mandate is created.\n\\* paypay - \\* south_korean_cards - \\* go_pay -\n\nPayments made via GoPay\n\\* bancontact -\n\nPayments made via Bancontact Card.\n\\* dotpay -\n\nPayments made via Dotpay.\n\\* automated_bank_transfer -\n\nRepresents virtual bank account using which the payment will be done.\n\\* upi -\n\nUPI Payments.\n\\* google_pay -\n\nPayments made via Google Pay.\n\\* revolut_pay -\n\nPayments made via Revolut Pay.\n\\* amazon_payments -\n\nPayments made via Amazon Payments.\n\\* klarna -\n\nPayments made via Klarna.\n\\* gcash - \\* paypal_express_checkout -\n\nPayments made via PayPal Express Checkout.\n\\* after_pay -\n\nPayments made via Afterpay\n\\* card -\n\nCard based payment including credit cards and debit cards. Details about the card can be obtained from the card resource.\n\\* ideal -\n\nPayments made via iDEAL.\n\\* pix -\n\nPayments made via Pix\n\\* pay_by_bank -\n\nPay By Bank\n\\* stablecoin -\n\nPayments made via Stablecoin.\n\\* sofort -\n\nPayments made via Sofort.\n\\* alipay -\n\nPayments made via Alipay. \nThis payment source is deprecated.\n\\* twint -\n\nPayments made via Twint\n\\* electronic_payment_standard -\n\nElectronic Payment Standard\n\\* generic -\n\nPayments made via Generic Payment Method.\n\\* klarna_pay_now -\n\nPayments made via Klarna Pay Now\n\\* netbanking_emandates -\n\nNetbanking (eMandates) Payments.\n\\* payme -\n\nPayments made via PayMe\n\\* online_banking_poland -\n\nPayments made via Online Banking Poland\n\\* pay_to -\n\nPayments made via PayTo\n\\* unionpay -\n\nPayments made via UnionPay.\n\\* faster_payments -\n\nPayments made via Faster Payments\n\\* pay_co -\n\nPayments made via PayCo\n\\* swish -\n\nPayments made via Swish\n\\* trustly -\n\nTrustly\n\\* venmo -\n\nPayments made via Venmo\n\\* kbc_payment_button -\n\nKBC Payment Button\n\\* giropay -\n\nPayments made via giropay.\n\\* kakao_pay -\n\nPayments made via Kakao Pay.\n\\* alipay_hk - \\* wechat_pay -\n\nPayments made via WeChat Pay. \nThis payment source is deprecated.\n\\* payconiq_by_bancontact -\n\nPayments made via Payconiq by Bancontact.\n\\* naver_pay -\n\nPayments made via Naver Pay.\n\\* cash_app_pay -\n\nPayments made via Cash App Pay.\n", - "enum" : [ "card", "paypal_express_checkout", "amazon_payments", "direct_debit", "generic", "alipay", "unionpay", "wechat_pay", "ideal", "google_pay", "sofort", "bancontact", "giropay", "dotpay", "upi", "netbanking_emandates", "venmo", "pay_to", "faster_payments", "sepa_instant_transfer", "automated_bank_transfer", "klarna_pay_now", "online_banking_poland", "payconiq_by_bancontact", "electronic_payment_standard", "kbc_payment_button", "pay_by_bank", "trustly", "stablecoin", "kakao_pay", "naver_pay", "revolut_pay", "cash_app_pay", "twint", "go_pay", "grab_pay", "pay_co", "after_pay", "swish", "payme", "pix", "klarna", "alipay_hk", "paypay", "gcash", "south_korean_cards" ], + "enum" : [ "card", "paypal_express_checkout", "amazon_payments", "direct_debit", "generic", "alipay", "unionpay", "wechat_pay", "ideal", "google_pay", "sofort", "bancontact", "giropay", "dotpay", "upi", "netbanking_emandates", "venmo", "pay_to", "faster_payments", "sepa_instant_transfer", "automated_bank_transfer", "klarna_pay_now", "online_banking_poland", "payconiq_by_bancontact", "electronic_payment_standard", "kbc_payment_button", "pay_by_bank", "trustly", "stablecoin", "kakao_pay", "naver_pay", "revolut_pay", "cash_app_pay", "twint", "go_pay", "grab_pay", "pay_co", "after_pay", "swish", "payme", "pix", "klarna", "alipay_hk", "paypay", "gcash", "south_korean_cards", "paynow", "bizum", "promptpay" ], "example" : null }, "gateway_account_id" : { @@ -18352,7 +18372,7 @@ "auto_close_invoices" : { "type" : "boolean", "deprecated" : false, - "description" : "Override for this customer, the [site-level setting](https://www.chargebee.com/docs/2.0/metered_billing.html#configuring-metered-billing)\nfor auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute is also available at the [subscription level](/docs/api/subscriptions/subscription-object#auto_close_invoices)\nwhich takes precedence.\n", + "description" : "Override for this customer, the [site-level setting](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing)\nfor auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute is also available at the [subscription level](/docs/api/subscriptions/subscription-object#auto_close_invoices)\nwhich takes precedence.\n", "example" : null }, "meta_data" : { @@ -19648,7 +19668,7 @@ }, { "name" : "auto_close_invoices", "in" : "query", - "description" : "optional, boolean filter\n\nOverride for this customer, the [site-level setting](https://www.chargebee.com/docs/2.0/metered_billing.html#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", + "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", @@ -20301,7 +20321,7 @@ "auto_close_invoices" : { "type" : "boolean", "deprecated" : false, - "description" : "Override for this customer, the [site-level setting](https://www.chargebee.com/docs/2.0/metered_billing.html#configuring-metered-billing)\nfor auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute is also available at the [subscription level](/docs/api/subscriptions/subscription-object#auto_close_invoices)\nwhich takes precedence.\n", + "description" : "Override for this customer, the [site-level setting](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing)\nfor auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute is also available at the [subscription level](/docs/api/subscriptions/subscription-object#auto_close_invoices)\nwhich takes precedence.\n", "example" : null }, "consolidated_invoicing" : { @@ -20587,7 +20607,7 @@ "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\\* go_pay -\n\nPayments made via GoPay\n\\* google_pay -\n\nPayments made via Google Pay.\n\\* after_pay -\n\nPayments made via Afterpay\n\\* pix -\n\nPayments made via Pix\n\\* pay_by_bank -\n\nPay By Bank\n\\* sofort -\n\nPayments made via Sofort.\n\\* twint -\n\nPayments made via Twint\n\\* netbanking_emandates -\n\nNetbanking (eMandates) Payments.\n\\* apple_pay -\n\nPayments made via Apple Pay.\n\\* unionpay -\n\nPayments made via UnionPay.\n\\* giropay -\n\nPayments made via giropay.\n\\* direct_debit -\n\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\\* upi -\n\nUPI Payments.\n\\* revolut_pay -\n\nPayments made via Revolut Pay.\n\\* stablecoin -\n\nPayments made via Stablecoin.\n\\* alipay -\n\nPayments made via Alipay. \nThis payment source is deprecated.\n\\* payme -\n\nPayments made via PayMe\n\\* pay_to -\n\nPayments made via PayTo\n\\* pay_co -\n\nPayments made via PayCo\n\\* kakao_pay -\n\nPayments made via Kakao Pay.\n\\* wechat_pay -\n\nPayments made via WeChat Pay. \nThis payment source is deprecated.\n\\* sepa_instant_transfer -\n\nPayments made via Sepa Instant Transfer\n\\* dotpay -\n\nPayments made via Dotpay.\n\\* klarna -\n\nPayments made via Klarna.\n\\* paypal_express_checkout -\n\nPayments made via PayPal Express Checkout.\n\\* ideal -\n\nPayments made via iDEAL.\n\\* electronic_payment_standard -\n\nElectronic Payment Standard\n\\* generic -\n\nPayments made via Generic Payment Method.\n\\* klarna_pay_now -\n\nPayments made via Klarna Pay Now\n\\* faster_payments -\n\nPayments made via Faster Payments\n\\* swish -\n\nPayments made via Swish\n\\* venmo -\n\nPayments made via Venmo\n\\* payconiq_by_bancontact -\n\nPayments made via Payconiq by Bancontact.\n\\* naver_pay -\n\nPayments made via Naver Pay.\n\\* automated_bank_transfer -\n\nRepresents virtual bank account using which the payment will be done.\n\\* amazon_payments -\n\nPayments made via Amazon Payments.\n\\* gcash - \\* card -\n\nCard based payment including credit cards and debit cards. Details about the card can be obtained from the card resource.\n\\* online_banking_poland -\n\nPayments made via Online Banking Poland\n\\* trustly -\n\nTrustly\n\\* kbc_payment_button -\n\nKBC Payment Button\n\\* alipay_hk - \\* 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" ], + "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" ], "example" : null }, "gateway_account_id" : { @@ -20658,7 +20678,7 @@ "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\\* card -\n\ncard\n\\* twint -\n\nPayments made via Twint\n\\* dotpay -\n\ndotpay\n\\* faster_payments -\n\nFaster Payments\n\\* upi -\n\nupi\n\\* kbc_payment_button -\n\nKBC Payment Button\n\\* klarna -\n\nPayments made via Klarna.\n\\* payme -\n\nPayments made via PayMe\n\\* google_pay -\n\ngoogle_pay\n\\* paypal_express_checkout -\n\npaypal_express_checkout\n\\* pix -\n\nPix\n\\* klarna_pay_now -\n\nKlarna Pay Now\n\\* ideal -\n\nideal\n\\* boleto -\n\nboleto\n\\* wechat_pay -\n\nPayments made via WeChat Pay.\n\\* after_pay -\n\nPayments made via Afterpay\n\\* grab_pay -\n\nPayments made via GrabPay\n\\* direct_debit -\n\ndirect_debit\n\\* sepa_instant_transfer -\n\nSepa Instant Transfer\n\\* bancontact -\n\nbancontact\n\\* kakao_pay -\n\nPayments made via Kakao Pay.\n\\* south_korean_cards - \\* swish -\n\nPayments made via Swish\n\\* go_pay -\n\nPayments made via GoPay\n\\* trustly -\n\nTrustly\n\\* naver_pay -\n\nPayments made via Naver Pay.\n\\* stablecoin -\n\nPayments made via Stablecoin.\n\\* venmo -\n\nVenmo\n\\* alipay -\n\nPayments made via Alipay.\n\\* pay_to -\n\nPayTo\n\\* pay_co -\n\nPayments made via PayCo\n\\* cash_app_pay -\n\nPayments made via Cash App Pay.\n\\* alipay_hk - \\* netbanking_emandates -\n\nnetbanking_emandates\n\\* paypay - \\* payconiq_by_bancontact -\n\nPayments made via Payconiq by Bancontact.\n\\* electronic_payment_standard -\n\nElectronic Payment Standard\n\\* pay_by_bank -\n\nPay By Bank\n\\* apple_pay -\n\napple_pay\n\\* online_banking_poland -\n\nOnline Banking Poland\n\\* gcash - \\* giropay -\n\ngiropay\n\\* sofort -\n\nsofort\n\\* amazon_payments -\n\nAmazon Payments\n\\* revolut_pay -\n\nPayments made via Revolut Pay.\n", - "enum" : [ "card", "ideal", "sofort", "bancontact", "google_pay", "dotpay", "giropay", "apple_pay", "upi", "netbanking_emandates", "paypal_express_checkout", "direct_debit", "boleto", "venmo", "amazon_payments", "pay_to", "faster_payments", "sepa_instant_transfer", "klarna_pay_now", "online_banking_poland", "payconiq_by_bancontact", "electronic_payment_standard", "kbc_payment_button", "pay_by_bank", "trustly", "stablecoin", "kakao_pay", "naver_pay", "revolut_pay", "cash_app_pay", "wechat_pay", "alipay", "twint", "go_pay", "grab_pay", "pay_co", "after_pay", "swish", "payme", "pix", "klarna", "alipay_hk", "paypay", "gcash", "south_korean_cards" ], + "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" ], "example" : null }, "reference_id" : { @@ -21640,7 +21660,7 @@ }, "/customers/{customer-id}/clear_personal_data" : { "post" : { - "summary" : "Clear Personal Data of a customer", + "summary" : "Clear personal data of a customer", "description" : "Clear personal details of a customer using this API.\n", "operationId" : "clear_personal_data_of_a_customer", "parameters" : [ { @@ -22330,7 +22350,7 @@ "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" ], + "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" ], "example" : null }, "gateway_account_id" : { @@ -22516,7 +22536,7 @@ "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\\* card -\n\ncard\n\\* twint -\n\nPayments made via Twint\n\\* swish -\n\nPayments made via Swish\n\\* dotpay -\n\ndotpay\n\\* faster_payments -\n\nFaster Payments\n\\* upi -\n\nupi\n\\* kbc_payment_button -\n\nKBC Payment Button\n\\* klarna -\n\nPayments made via Klarna.\n\\* payme -\n\nPayments made via PayMe\n\\* go_pay -\n\nPayments made via GoPay\n\\* google_pay -\n\ngoogle_pay\n\\* trustly -\n\nTrustly\n\\* naver_pay -\n\nPayments made via Naver Pay.\n\\* stablecoin -\n\nPayments made via Stablecoin.\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\\* ideal -\n\nideal\n\\* pay_to -\n\nPayTo\n\\* boleto -\n\nboleto\n\\* pay_co -\n\nPayments made via PayCo\n\\* wechat_pay -\n\nPayments made via WeChat Pay.\n\\* cash_app_pay -\n\nPayments made via Cash App Pay.\n\\* alipay_hk - \\* 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\\* electronic_payment_standard -\n\nElectronic Payment Standard\n\\* direct_debit -\n\ndirect_debit\n\\* sepa_instant_transfer -\n\nSepa Instant Transfer\n\\* bancontact -\n\nbancontact\n\\* pay_by_bank -\n\nPay By Bank\n\\* apple_pay -\n\napple_pay\n\\* online_banking_poland - \\* gcash - \\* giropay -\n\ngiropay\n\\* sofort -\n\nsofort\n\\* amazon_payments -\n\nAmazon Payments\n\\* kakao_pay -\n\nPayments made via Kakao Pay.\n\\* south_korean_cards - \\* revolut_pay -\n\nPayments made via Revolut Pay.\n", - "enum" : [ "card", "ideal", "sofort", "bancontact", "google_pay", "dotpay", "giropay", "apple_pay", "upi", "netbanking_emandates", "paypal_express_checkout", "direct_debit", "boleto", "venmo", "amazon_payments", "pay_to", "faster_payments", "sepa_instant_transfer", "klarna_pay_now", "online_banking_poland", "payconiq_by_bancontact", "electronic_payment_standard", "kbc_payment_button", "pay_by_bank", "trustly", "stablecoin", "kakao_pay", "naver_pay", "revolut_pay", "cash_app_pay", "wechat_pay", "alipay", "twint", "go_pay", "grab_pay", "pay_co", "after_pay", "swish", "payme", "pix", "klarna", "alipay_hk", "paypay", "gcash", "south_korean_cards" ], + "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" ], "example" : null }, "reference_id" : { @@ -24430,7 +24450,7 @@ "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" ], + "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" ], "example" : null }, "id_at_vault" : { @@ -24461,6 +24481,12 @@ "description" : "", "example" : null }, + "browser_details" : { + "type" : "object", + "additionalProperties" : true, + "deprecated" : false, + "example" : null + }, "token_additional_detail" : { "type" : "object", "deprecated" : false, @@ -24815,6 +24841,12 @@ "schema" : { "type" : "object", "properties" : { + "browser_details" : { + "type" : "object", + "additionalProperties" : true, + "deprecated" : false, + "example" : null + }, "card" : { "type" : "object", "deprecated" : false, @@ -25420,7 +25452,7 @@ "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" ], + "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" ], "example" : null }, "gateway_account_id" : { @@ -26880,28 +26912,28 @@ "properties" : { "is" : { "type" : "string", - "description" : "\\* \\`card\\` - Card based payment including credit cards and debit cards. Details about the card can be obtained from the card resource. \\* \\`paypal_express_checkout\\` - Payments made via PayPal Express Checkout. \\* \\`amazon_payments\\` - Payments made via Amazon Payments. \\* \\`direct_debit\\` - Represents bank account for which the direct debit or ACH agreement/mandate is created. \\* \\`generic\\` - Payments made via Generic Payment Method. \\* \\`alipay\\` - Payments made via Alipay \\* \\`unionpay\\` - Payments made via UnionPay. \\* \\`apple_pay\\` - Payments made via Apple Pay. \\* \\`wechat_pay\\` - Payments made via WeChat Pay \\* \\`ideal\\` - Payments made via iDEAL. \\* \\`google_pay\\` - Payments made via Google Pay. \\* \\`sofort\\` - Payments made via Sofort. \\* \\`bancontact\\` - Payments made via Bancontact Card. \\* \\`giropay\\` - Payments made via giropay. \\* \\`dotpay\\` - Payments made via Dotpay. \\* \\`upi\\` - UPI Payments. \\* \\`netbanking_emandates\\` - Netbanking (eMandates) Payments. \\* \\`venmo\\` - Payments made via Venmo \\* \\`pay_to\\` - Payments made via PayTo \\* \\`faster_payments\\` - Payments made via Faster Payments \\* \\`sepa_instant_transfer\\` - Payments made via Sepa Instant Transfer \\* \\`automated_bank_transfer\\` - Represents virtual bank account using which the payment will be done. \\* \\`klarna_pay_now\\` - Payments made via Klarna Pay Now \\* \\`online_banking_poland\\` - Payments made via Online Banking Poland \\* \\`payconiq_by_bancontact\\` - Payments made via Payconiq by Bancontact \\* \\`electronic_payment_standard\\` - Payments made via Electronic Payment Standard. \\* \\`kbc_payment_button\\` - Payments made via KBC Payment Button. \\* \\`pay_by_bank\\` - Payments made via Pay By Bank. \\* \\`trustly\\` - Payments made via Trustly. \\* \\`stablecoin\\` - Payments made via Stablecoin \\* \\`kakao_pay\\` - Payments made via Kakao Pay \\* \\`naver_pay\\` - Payments made via Naver Pay \\* \\`revolut_pay\\` - Payments made via Revolut Pay \\* \\`cash_app_pay\\` - Payments made via Cash App Pay \\* \\`twint\\` - Payments made via Twint \\* \\`go_pay\\` - Payments made via Go Pay \\* \\`grab_pay\\` - Payments made via Grab Pay \\* \\`pay_co\\` - Payments made via Pay Co \\* \\`after_pay\\` - Payments made via After pay \\* \\`swish\\` - Payments made via Swish \\* \\`payme\\` - Payments made via PayMe \\* \\`pix\\` - Payments made via Pix \\* \\`klarna\\` - Payments made via Klarna \\* \\`alipay_hk\\` - Payments made via Alipay HK \\* \\`paypay\\` - Payments made via PayPay \\* \\`gcash\\` - Payments made via GCash \\* \\`south_korean_cards\\` - Payments made via South Korean Cards\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" ], + "description" : "\\* \\`card\\` - Card based payment including credit cards and debit cards. Details about the card can be obtained from the card resource. \\* \\`paypal_express_checkout\\` - Payments made via PayPal Express Checkout. \\* \\`amazon_payments\\` - Payments made via Amazon Payments. \\* \\`direct_debit\\` - Represents bank account for which the direct debit or ACH agreement/mandate is created. \\* \\`generic\\` - Payments made via Generic Payment Method. \\* \\`alipay\\` - Payments made via Alipay \\* \\`unionpay\\` - Payments made via UnionPay. \\* \\`apple_pay\\` - Payments made via Apple Pay. \\* \\`wechat_pay\\` - Payments made via WeChat Pay \\* \\`ideal\\` - Payments made via iDEAL. \\* \\`google_pay\\` - Payments made via Google Pay. \\* \\`sofort\\` - Payments made via Sofort. \\* \\`bancontact\\` - Payments made via Bancontact Card. \\* \\`giropay\\` - Payments made via giropay. \\* \\`dotpay\\` - Payments made via Dotpay. \\* \\`upi\\` - UPI Payments. \\* \\`netbanking_emandates\\` - Netbanking (eMandates) Payments. \\* \\`venmo\\` - Payments made via Venmo \\* \\`pay_to\\` - Payments made via PayTo \\* \\`faster_payments\\` - Payments made via Faster Payments \\* \\`sepa_instant_transfer\\` - Payments made via Sepa Instant Transfer \\* \\`automated_bank_transfer\\` - Represents virtual bank account using which the payment will be done. \\* \\`klarna_pay_now\\` - Payments made via Klarna Pay Now \\* \\`online_banking_poland\\` - Payments made via Online Banking Poland \\* \\`payconiq_by_bancontact\\` - Payments made via Payconiq by Bancontact \\* \\`electronic_payment_standard\\` - Payments made via Electronic Payment Standard. \\* \\`kbc_payment_button\\` - Payments made via KBC Payment Button. \\* \\`pay_by_bank\\` - Payments made via Pay By Bank. \\* \\`trustly\\` - Payments made via Trustly. \\* \\`stablecoin\\` - Payments made via Stablecoin \\* \\`kakao_pay\\` - Payments made via Kakao Pay \\* \\`naver_pay\\` - Payments made via Naver Pay \\* \\`revolut_pay\\` - Payments made via Revolut Pay \\* \\`cash_app_pay\\` - Payments made via Cash App Pay \\* \\`twint\\` - Payments made via Twint \\* \\`go_pay\\` - Payments made via Go Pay \\* \\`grab_pay\\` - Payments made via Grab Pay \\* \\`pay_co\\` - Payments made via Pay Co \\* \\`after_pay\\` - Payments made via After pay \\* \\`swish\\` - Payments made via Swish \\* \\`payme\\` - Payments made via PayMe \\* \\`pix\\` - Payments made via Pix \\* \\`klarna\\` - Payments made via Klarna \\* \\`alipay_hk\\` - Payments made via Alipay HK \\* \\`paypay\\` - Payments made via PayPay \\* \\`gcash\\` - Payments made via GCash \\* \\`south_korean_cards\\` - Payments made via South Korean Cards \\* \\`paynow\\` - Payments made via PayNow \\* \\`bizum\\` - Payments made via Bizum \\* \\`promptpay\\` - Payments made via PromptPay\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" ], "example" : null }, "is_not" : { "type" : "string", - "description" : "\\* \\`card\\` - Card based payment including credit cards and debit cards. Details about the card can be obtained from the card resource. \\* \\`paypal_express_checkout\\` - Payments made via PayPal Express Checkout. \\* \\`amazon_payments\\` - Payments made via Amazon Payments. \\* \\`direct_debit\\` - Represents bank account for which the direct debit or ACH agreement/mandate is created. \\* \\`generic\\` - Payments made via Generic Payment Method. \\* \\`alipay\\` - Payments made via Alipay \\* \\`unionpay\\` - Payments made via UnionPay. \\* \\`apple_pay\\` - Payments made via Apple Pay. \\* \\`wechat_pay\\` - Payments made via WeChat Pay \\* \\`ideal\\` - Payments made via iDEAL. \\* \\`google_pay\\` - Payments made via Google Pay. \\* \\`sofort\\` - Payments made via Sofort. \\* \\`bancontact\\` - Payments made via Bancontact Card. \\* \\`giropay\\` - Payments made via giropay. \\* \\`dotpay\\` - Payments made via Dotpay. \\* \\`upi\\` - UPI Payments. \\* \\`netbanking_emandates\\` - Netbanking (eMandates) Payments. \\* \\`venmo\\` - Payments made via Venmo \\* \\`pay_to\\` - Payments made via PayTo \\* \\`faster_payments\\` - Payments made via Faster Payments \\* \\`sepa_instant_transfer\\` - Payments made via Sepa Instant Transfer \\* \\`automated_bank_transfer\\` - Represents virtual bank account using which the payment will be done. \\* \\`klarna_pay_now\\` - Payments made via Klarna Pay Now \\* \\`online_banking_poland\\` - Payments made via Online Banking Poland \\* \\`payconiq_by_bancontact\\` - Payments made via Payconiq by Bancontact \\* \\`electronic_payment_standard\\` - Payments made via Electronic Payment Standard. \\* \\`kbc_payment_button\\` - Payments made via KBC Payment Button. \\* \\`pay_by_bank\\` - Payments made via Pay By Bank. \\* \\`trustly\\` - Payments made via Trustly. \\* \\`stablecoin\\` - Payments made via Stablecoin \\* \\`kakao_pay\\` - Payments made via Kakao Pay \\* \\`naver_pay\\` - Payments made via Naver Pay \\* \\`revolut_pay\\` - Payments made via Revolut Pay \\* \\`cash_app_pay\\` - Payments made via Cash App Pay \\* \\`twint\\` - Payments made via Twint \\* \\`go_pay\\` - Payments made via Go Pay \\* \\`grab_pay\\` - Payments made via Grab Pay \\* \\`pay_co\\` - Payments made via Pay Co \\* \\`after_pay\\` - Payments made via After pay \\* \\`swish\\` - Payments made via Swish \\* \\`payme\\` - Payments made via PayMe \\* \\`pix\\` - Payments made via Pix \\* \\`klarna\\` - Payments made via Klarna \\* \\`alipay_hk\\` - Payments made via Alipay HK \\* \\`paypay\\` - Payments made via PayPay \\* \\`gcash\\` - Payments made via GCash \\* \\`south_korean_cards\\` - Payments made via South Korean Cards\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" ], + "description" : "\\* \\`card\\` - Card based payment including credit cards and debit cards. Details about the card can be obtained from the card resource. \\* \\`paypal_express_checkout\\` - Payments made via PayPal Express Checkout. \\* \\`amazon_payments\\` - Payments made via Amazon Payments. \\* \\`direct_debit\\` - Represents bank account for which the direct debit or ACH agreement/mandate is created. \\* \\`generic\\` - Payments made via Generic Payment Method. \\* \\`alipay\\` - Payments made via Alipay \\* \\`unionpay\\` - Payments made via UnionPay. \\* \\`apple_pay\\` - Payments made via Apple Pay. \\* \\`wechat_pay\\` - Payments made via WeChat Pay \\* \\`ideal\\` - Payments made via iDEAL. \\* \\`google_pay\\` - Payments made via Google Pay. \\* \\`sofort\\` - Payments made via Sofort. \\* \\`bancontact\\` - Payments made via Bancontact Card. \\* \\`giropay\\` - Payments made via giropay. \\* \\`dotpay\\` - Payments made via Dotpay. \\* \\`upi\\` - UPI Payments. \\* \\`netbanking_emandates\\` - Netbanking (eMandates) Payments. \\* \\`venmo\\` - Payments made via Venmo \\* \\`pay_to\\` - Payments made via PayTo \\* \\`faster_payments\\` - Payments made via Faster Payments \\* \\`sepa_instant_transfer\\` - Payments made via Sepa Instant Transfer \\* \\`automated_bank_transfer\\` - Represents virtual bank account using which the payment will be done. \\* \\`klarna_pay_now\\` - Payments made via Klarna Pay Now \\* \\`online_banking_poland\\` - Payments made via Online Banking Poland \\* \\`payconiq_by_bancontact\\` - Payments made via Payconiq by Bancontact \\* \\`electronic_payment_standard\\` - Payments made via Electronic Payment Standard. \\* \\`kbc_payment_button\\` - Payments made via KBC Payment Button. \\* \\`pay_by_bank\\` - Payments made via Pay By Bank. \\* \\`trustly\\` - Payments made via Trustly. \\* \\`stablecoin\\` - Payments made via Stablecoin \\* \\`kakao_pay\\` - Payments made via Kakao Pay \\* \\`naver_pay\\` - Payments made via Naver Pay \\* \\`revolut_pay\\` - Payments made via Revolut Pay \\* \\`cash_app_pay\\` - Payments made via Cash App Pay \\* \\`twint\\` - Payments made via Twint \\* \\`go_pay\\` - Payments made via Go Pay \\* \\`grab_pay\\` - Payments made via Grab Pay \\* \\`pay_co\\` - Payments made via Pay Co \\* \\`after_pay\\` - Payments made via After pay \\* \\`swish\\` - Payments made via Swish \\* \\`payme\\` - Payments made via PayMe \\* \\`pix\\` - Payments made via Pix \\* \\`klarna\\` - Payments made via Klarna \\* \\`alipay_hk\\` - Payments made via Alipay HK \\* \\`paypay\\` - Payments made via PayPay \\* \\`gcash\\` - Payments made via GCash \\* \\`south_korean_cards\\` - Payments made via South Korean Cards \\* \\`paynow\\` - Payments made via PayNow \\* \\`bizum\\` - Payments made via Bizum \\* \\`promptpay\\` - Payments made via PromptPay\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" ], "example" : null }, "in" : { "type" : "string", - "description" : "\\* \\`card\\` - Card based payment including credit cards and debit cards. Details about the card can be obtained from the card resource. \\* \\`paypal_express_checkout\\` - Payments made via PayPal Express Checkout. \\* \\`amazon_payments\\` - Payments made via Amazon Payments. \\* \\`direct_debit\\` - Represents bank account for which the direct debit or ACH agreement/mandate is created. \\* \\`generic\\` - Payments made via Generic Payment Method. \\* \\`alipay\\` - Payments made via Alipay \\* \\`unionpay\\` - Payments made via UnionPay. \\* \\`apple_pay\\` - Payments made via Apple Pay. \\* \\`wechat_pay\\` - Payments made via WeChat Pay \\* \\`ideal\\` - Payments made via iDEAL. \\* \\`google_pay\\` - Payments made via Google Pay. \\* \\`sofort\\` - Payments made via Sofort. \\* \\`bancontact\\` - Payments made via Bancontact Card. \\* \\`giropay\\` - Payments made via giropay. \\* \\`dotpay\\` - Payments made via Dotpay. \\* \\`upi\\` - UPI Payments. \\* \\`netbanking_emandates\\` - Netbanking (eMandates) Payments. \\* \\`venmo\\` - Payments made via Venmo \\* \\`pay_to\\` - Payments made via PayTo \\* \\`faster_payments\\` - Payments made via Faster Payments \\* \\`sepa_instant_transfer\\` - Payments made via Sepa Instant Transfer \\* \\`automated_bank_transfer\\` - Represents virtual bank account using which the payment will be done. \\* \\`klarna_pay_now\\` - Payments made via Klarna Pay Now \\* \\`online_banking_poland\\` - Payments made via Online Banking Poland \\* \\`payconiq_by_bancontact\\` - Payments made via Payconiq by Bancontact \\* \\`electronic_payment_standard\\` - Payments made via Electronic Payment Standard. \\* \\`kbc_payment_button\\` - Payments made via KBC Payment Button. \\* \\`pay_by_bank\\` - Payments made via Pay By Bank. \\* \\`trustly\\` - Payments made via Trustly. \\* \\`stablecoin\\` - Payments made via Stablecoin \\* \\`kakao_pay\\` - Payments made via Kakao Pay \\* \\`naver_pay\\` - Payments made via Naver Pay \\* \\`revolut_pay\\` - Payments made via Revolut Pay \\* \\`cash_app_pay\\` - Payments made via Cash App Pay \\* \\`twint\\` - Payments made via Twint \\* \\`go_pay\\` - Payments made via Go Pay \\* \\`grab_pay\\` - Payments made via Grab Pay \\* \\`pay_co\\` - Payments made via Pay Co \\* \\`after_pay\\` - Payments made via After pay \\* \\`swish\\` - Payments made via Swish \\* \\`payme\\` - Payments made via PayMe \\* \\`pix\\` - Payments made via Pix \\* \\`klarna\\` - Payments made via Klarna \\* \\`alipay_hk\\` - Payments made via Alipay HK \\* \\`paypay\\` - Payments made via PayPay \\* \\`gcash\\` - Payments made via GCash \\* \\`south_korean_cards\\` - Payments made via South Korean Cards\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" ], - "pattern" : "^\\[(card|paypal_express_checkout|amazon_payments|direct_debit|generic|alipay|unionpay|apple_pay|wechat_pay|ideal|google_pay|sofort|bancontact|giropay|dotpay|upi|netbanking_emandates|venmo|pay_to|faster_payments|sepa_instant_transfer|automated_bank_transfer|klarna_pay_now|online_banking_poland|payconiq_by_bancontact|electronic_payment_standard|kbc_payment_button|pay_by_bank|trustly|stablecoin|kakao_pay|naver_pay|revolut_pay|cash_app_pay|twint|go_pay|grab_pay|pay_co|after_pay|swish|payme|pix|klarna|alipay_hk|paypay|gcash|south_korean_cards)(,(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))*\\]$", + "description" : "\\* \\`card\\` - Card based payment including credit cards and debit cards. Details about the card can be obtained from the card resource. \\* \\`paypal_express_checkout\\` - Payments made via PayPal Express Checkout. \\* \\`amazon_payments\\` - Payments made via Amazon Payments. \\* \\`direct_debit\\` - Represents bank account for which the direct debit or ACH agreement/mandate is created. \\* \\`generic\\` - Payments made via Generic Payment Method. \\* \\`alipay\\` - Payments made via Alipay \\* \\`unionpay\\` - Payments made via UnionPay. \\* \\`apple_pay\\` - Payments made via Apple Pay. \\* \\`wechat_pay\\` - Payments made via WeChat Pay \\* \\`ideal\\` - Payments made via iDEAL. \\* \\`google_pay\\` - Payments made via Google Pay. \\* \\`sofort\\` - Payments made via Sofort. \\* \\`bancontact\\` - Payments made via Bancontact Card. \\* \\`giropay\\` - Payments made via giropay. \\* \\`dotpay\\` - Payments made via Dotpay. \\* \\`upi\\` - UPI Payments. \\* \\`netbanking_emandates\\` - Netbanking (eMandates) Payments. \\* \\`venmo\\` - Payments made via Venmo \\* \\`pay_to\\` - Payments made via PayTo \\* \\`faster_payments\\` - Payments made via Faster Payments \\* \\`sepa_instant_transfer\\` - Payments made via Sepa Instant Transfer \\* \\`automated_bank_transfer\\` - Represents virtual bank account using which the payment will be done. \\* \\`klarna_pay_now\\` - Payments made via Klarna Pay Now \\* \\`online_banking_poland\\` - Payments made via Online Banking Poland \\* \\`payconiq_by_bancontact\\` - Payments made via Payconiq by Bancontact \\* \\`electronic_payment_standard\\` - Payments made via Electronic Payment Standard. \\* \\`kbc_payment_button\\` - Payments made via KBC Payment Button. \\* \\`pay_by_bank\\` - Payments made via Pay By Bank. \\* \\`trustly\\` - Payments made via Trustly. \\* \\`stablecoin\\` - Payments made via Stablecoin \\* \\`kakao_pay\\` - Payments made via Kakao Pay \\* \\`naver_pay\\` - Payments made via Naver Pay \\* \\`revolut_pay\\` - Payments made via Revolut Pay \\* \\`cash_app_pay\\` - Payments made via Cash App Pay \\* \\`twint\\` - Payments made via Twint \\* \\`go_pay\\` - Payments made via Go Pay \\* \\`grab_pay\\` - Payments made via Grab Pay \\* \\`pay_co\\` - Payments made via Pay Co \\* \\`after_pay\\` - Payments made via After pay \\* \\`swish\\` - Payments made via Swish \\* \\`payme\\` - Payments made via PayMe \\* \\`pix\\` - Payments made via Pix \\* \\`klarna\\` - Payments made via Klarna \\* \\`alipay_hk\\` - Payments made via Alipay HK \\* \\`paypay\\` - Payments made via PayPay \\* \\`gcash\\` - Payments made via GCash \\* \\`south_korean_cards\\` - Payments made via South Korean Cards \\* \\`paynow\\` - Payments made via PayNow \\* \\`bizum\\` - Payments made via Bizum \\* \\`promptpay\\` - Payments made via PromptPay\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" ], + "pattern" : "^\\[(card|paypal_express_checkout|amazon_payments|direct_debit|generic|alipay|unionpay|apple_pay|wechat_pay|ideal|google_pay|sofort|bancontact|giropay|dotpay|upi|netbanking_emandates|venmo|pay_to|faster_payments|sepa_instant_transfer|automated_bank_transfer|klarna_pay_now|online_banking_poland|payconiq_by_bancontact|electronic_payment_standard|kbc_payment_button|pay_by_bank|trustly|stablecoin|kakao_pay|naver_pay|revolut_pay|cash_app_pay|twint|go_pay|grab_pay|pay_co|after_pay|swish|payme|pix|klarna|alipay_hk|paypay|gcash|south_korean_cards|paynow|bizum|promptpay)(,(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))*\\]$", "example" : null }, "not_in" : { "type" : "string", - "description" : "\\* \\`card\\` - Card based payment including credit cards and debit cards. Details about the card can be obtained from the card resource. \\* \\`paypal_express_checkout\\` - Payments made via PayPal Express Checkout. \\* \\`amazon_payments\\` - Payments made via Amazon Payments. \\* \\`direct_debit\\` - Represents bank account for which the direct debit or ACH agreement/mandate is created. \\* \\`generic\\` - Payments made via Generic Payment Method. \\* \\`alipay\\` - Payments made via Alipay \\* \\`unionpay\\` - Payments made via UnionPay. \\* \\`apple_pay\\` - Payments made via Apple Pay. \\* \\`wechat_pay\\` - Payments made via WeChat Pay \\* \\`ideal\\` - Payments made via iDEAL. \\* \\`google_pay\\` - Payments made via Google Pay. \\* \\`sofort\\` - Payments made via Sofort. \\* \\`bancontact\\` - Payments made via Bancontact Card. \\* \\`giropay\\` - Payments made via giropay. \\* \\`dotpay\\` - Payments made via Dotpay. \\* \\`upi\\` - UPI Payments. \\* \\`netbanking_emandates\\` - Netbanking (eMandates) Payments. \\* \\`venmo\\` - Payments made via Venmo \\* \\`pay_to\\` - Payments made via PayTo \\* \\`faster_payments\\` - Payments made via Faster Payments \\* \\`sepa_instant_transfer\\` - Payments made via Sepa Instant Transfer \\* \\`automated_bank_transfer\\` - Represents virtual bank account using which the payment will be done. \\* \\`klarna_pay_now\\` - Payments made via Klarna Pay Now \\* \\`online_banking_poland\\` - Payments made via Online Banking Poland \\* \\`payconiq_by_bancontact\\` - Payments made via Payconiq by Bancontact \\* \\`electronic_payment_standard\\` - Payments made via Electronic Payment Standard. \\* \\`kbc_payment_button\\` - Payments made via KBC Payment Button. \\* \\`pay_by_bank\\` - Payments made via Pay By Bank. \\* \\`trustly\\` - Payments made via Trustly. \\* \\`stablecoin\\` - Payments made via Stablecoin \\* \\`kakao_pay\\` - Payments made via Kakao Pay \\* \\`naver_pay\\` - Payments made via Naver Pay \\* \\`revolut_pay\\` - Payments made via Revolut Pay \\* \\`cash_app_pay\\` - Payments made via Cash App Pay \\* \\`twint\\` - Payments made via Twint \\* \\`go_pay\\` - Payments made via Go Pay \\* \\`grab_pay\\` - Payments made via Grab Pay \\* \\`pay_co\\` - Payments made via Pay Co \\* \\`after_pay\\` - Payments made via After pay \\* \\`swish\\` - Payments made via Swish \\* \\`payme\\` - Payments made via PayMe \\* \\`pix\\` - Payments made via Pix \\* \\`klarna\\` - Payments made via Klarna \\* \\`alipay_hk\\` - Payments made via Alipay HK \\* \\`paypay\\` - Payments made via PayPay \\* \\`gcash\\` - Payments made via GCash \\* \\`south_korean_cards\\` - Payments made via South Korean Cards\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" ], - "pattern" : "^\\[(card|paypal_express_checkout|amazon_payments|direct_debit|generic|alipay|unionpay|apple_pay|wechat_pay|ideal|google_pay|sofort|bancontact|giropay|dotpay|upi|netbanking_emandates|venmo|pay_to|faster_payments|sepa_instant_transfer|automated_bank_transfer|klarna_pay_now|online_banking_poland|payconiq_by_bancontact|electronic_payment_standard|kbc_payment_button|pay_by_bank|trustly|stablecoin|kakao_pay|naver_pay|revolut_pay|cash_app_pay|twint|go_pay|grab_pay|pay_co|after_pay|swish|payme|pix|klarna|alipay_hk|paypay|gcash|south_korean_cards)(,(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))*\\]$", + "description" : "\\* \\`card\\` - Card based payment including credit cards and debit cards. Details about the card can be obtained from the card resource. \\* \\`paypal_express_checkout\\` - Payments made via PayPal Express Checkout. \\* \\`amazon_payments\\` - Payments made via Amazon Payments. \\* \\`direct_debit\\` - Represents bank account for which the direct debit or ACH agreement/mandate is created. \\* \\`generic\\` - Payments made via Generic Payment Method. \\* \\`alipay\\` - Payments made via Alipay \\* \\`unionpay\\` - Payments made via UnionPay. \\* \\`apple_pay\\` - Payments made via Apple Pay. \\* \\`wechat_pay\\` - Payments made via WeChat Pay \\* \\`ideal\\` - Payments made via iDEAL. \\* \\`google_pay\\` - Payments made via Google Pay. \\* \\`sofort\\` - Payments made via Sofort. \\* \\`bancontact\\` - Payments made via Bancontact Card. \\* \\`giropay\\` - Payments made via giropay. \\* \\`dotpay\\` - Payments made via Dotpay. \\* \\`upi\\` - UPI Payments. \\* \\`netbanking_emandates\\` - Netbanking (eMandates) Payments. \\* \\`venmo\\` - Payments made via Venmo \\* \\`pay_to\\` - Payments made via PayTo \\* \\`faster_payments\\` - Payments made via Faster Payments \\* \\`sepa_instant_transfer\\` - Payments made via Sepa Instant Transfer \\* \\`automated_bank_transfer\\` - Represents virtual bank account using which the payment will be done. \\* \\`klarna_pay_now\\` - Payments made via Klarna Pay Now \\* \\`online_banking_poland\\` - Payments made via Online Banking Poland \\* \\`payconiq_by_bancontact\\` - Payments made via Payconiq by Bancontact \\* \\`electronic_payment_standard\\` - Payments made via Electronic Payment Standard. \\* \\`kbc_payment_button\\` - Payments made via KBC Payment Button. \\* \\`pay_by_bank\\` - Payments made via Pay By Bank. \\* \\`trustly\\` - Payments made via Trustly. \\* \\`stablecoin\\` - Payments made via Stablecoin \\* \\`kakao_pay\\` - Payments made via Kakao Pay \\* \\`naver_pay\\` - Payments made via Naver Pay \\* \\`revolut_pay\\` - Payments made via Revolut Pay \\* \\`cash_app_pay\\` - Payments made via Cash App Pay \\* \\`twint\\` - Payments made via Twint \\* \\`go_pay\\` - Payments made via Go Pay \\* \\`grab_pay\\` - Payments made via Grab Pay \\* \\`pay_co\\` - Payments made via Pay Co \\* \\`after_pay\\` - Payments made via After pay \\* \\`swish\\` - Payments made via Swish \\* \\`payme\\` - Payments made via PayMe \\* \\`pix\\` - Payments made via Pix \\* \\`klarna\\` - Payments made via Klarna \\* \\`alipay_hk\\` - Payments made via Alipay HK \\* \\`paypay\\` - Payments made via PayPay \\* \\`gcash\\` - Payments made via GCash \\* \\`south_korean_cards\\` - Payments made via South Korean Cards \\* \\`paynow\\` - Payments made via PayNow \\* \\`bizum\\` - Payments made via Bizum \\* \\`promptpay\\` - Payments made via PromptPay\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" ], + "pattern" : "^\\[(card|paypal_express_checkout|amazon_payments|direct_debit|generic|alipay|unionpay|apple_pay|wechat_pay|ideal|google_pay|sofort|bancontact|giropay|dotpay|upi|netbanking_emandates|venmo|pay_to|faster_payments|sepa_instant_transfer|automated_bank_transfer|klarna_pay_now|online_banking_poland|payconiq_by_bancontact|electronic_payment_standard|kbc_payment_button|pay_by_bank|trustly|stablecoin|kakao_pay|naver_pay|revolut_pay|cash_app_pay|twint|go_pay|grab_pay|pay_co|after_pay|swish|payme|pix|klarna|alipay_hk|paypay|gcash|south_korean_cards|paynow|bizum|promptpay)(,(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))*\\]$", "example" : null } } @@ -27620,7 +27652,7 @@ "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" ], + "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" ], "example" : null }, "reference_id" : { @@ -28430,7 +28462,7 @@ "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" ], + "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" ], "example" : null }, "tmp_token" : { @@ -34053,7 +34085,7 @@ }, "/promotional_credits/deduct" : { "post" : { - "summary" : "Deduct Promotional Credits", + "summary" : "Deduct promotional credits", "description" : "This API call can be used to deduct promotional credits for a customer. [Learn more about Promotional Credits](https://www.chargebee.com/docs/2.0/credit-notes.html#creating-promotional-credits).\n\nFor example, if a customer has a credit balance of $20, if you pass the **amount** as $5, then the customer's credit balance would become $15.\n\nIf you do not pass any amount as the input parameter then, it will deduct the whole available amount from the credit balance.\n", "operationId" : "deduct_promotional_credits", "parameters" : [ { @@ -34358,7 +34390,7 @@ }, "/promotional_credits/set" : { "post" : { - "summary" : "Set Promotional Credits", + "summary" : "Set promotional credits", "description" : "This API call can be used to set the promotional credits balance of a customer. [Learn more about Promotional Credits](https://www.chargebee.com/docs/2.0/credit-notes.html#creating-promotional-credits).\n\nFor example,\n\n* If a customer has a credit balance of $10 and if you would like to set the balance to $100, you could pass the **amount** as $100.\n* If a customer has a credit balance of $10 and if you would like to set the balance to $5, you could pass the **amount** as $5.\n* If a customer has a credit balance of $10 and if you would like to clear the balance, you could pass the **amount** as $0.\n", "operationId" : "set_promotional_credits", "parameters" : [ { @@ -34663,7 +34695,7 @@ }, "/promotional_credits/add" : { "post" : { - "summary" : "Add Promotional Credits", + "summary" : "Add promotional credits", "description" : "This API call can be used to add promotional credits to a customer. [Learn more about Promotional Credits](https://www.chargebee.com/docs/2.0/credit-notes.html#creating-promotional-credits).\n\nFor example, if a customer has credits of $10, if you pass the **amount** as $10, then the customer's credit balance would become $20.\n", "operationId" : "add_promotional_credits", "parameters" : [ { @@ -34968,7 +35000,7 @@ }, "/invoices/{invoice-id}/delete_line_items" : { "post" : { - "summary" : "Delete Line Items", + "summary" : "Delete line items", "description" : "This endpoint is used to delete line items from \"Pending\" invoice.\n", "operationId" : "delete_line_items", "parameters" : [ { @@ -40317,7 +40349,7 @@ "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\\* go_pay -\n\nPayments made via GoPay\n\\* google_pay -\n\nPayments made via Google Pay.\n\\* after_pay -\n\nPayments made via Afterpay\n\\* pix -\n\nPayments made via Pix\n\\* pay_by_bank -\n\nPay By Bank\n\\* sofort -\n\nPayments made via Sofort.\n\\* twint -\n\nPayments made via Twint\n\\* netbanking_emandates -\n\nNetbanking (eMandates) Payments.\n\\* apple_pay -\n\nPayments made via Apple Pay.\n\\* unionpay -\n\nPayments made via UnionPay.\n\\* giropay -\n\nPayments made via giropay.\n\\* direct_debit -\n\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\\* upi -\n\nUPI Payments.\n\\* revolut_pay -\n\nPayments made via Revolut Pay.\n\\* stablecoin -\n\nPayments made via Stablecoin.\n\\* alipay -\n\nPayments made via Alipay. \nThis payment source is deprecated.\n\\* payme -\n\nPayments made via PayMe\n\\* pay_to -\n\nPayments made via PayTo\n\\* pay_co -\n\nPayments made via PayCo\n\\* kakao_pay -\n\nPayments made via Kakao Pay.\n\\* wechat_pay -\n\nPayments made via WeChat Pay. \nThis payment source is deprecated.\n\\* sepa_instant_transfer -\n\nPayments made via Sepa Instant Transfer\n\\* dotpay -\n\nPayments made via Dotpay.\n\\* klarna -\n\nPayments made via Klarna.\n\\* paypal_express_checkout -\n\nPayments made via PayPal Express Checkout.\n\\* ideal -\n\nPayments made via iDEAL.\n\\* electronic_payment_standard -\n\nElectronic Payment Standard\n\\* generic -\n\nPayments made via Generic Payment Method.\n\\* klarna_pay_now -\n\nPayments made via Klarna Pay Now\n\\* faster_payments -\n\nPayments made via Faster Payments\n\\* swish -\n\nPayments made via Swish\n\\* venmo -\n\nPayments made via Venmo\n\\* payconiq_by_bancontact -\n\nPayments made via Payconiq by Bancontact.\n\\* naver_pay -\n\nPayments made via Naver Pay.\n\\* automated_bank_transfer -\n\nRepresents virtual bank account using which the payment will be done.\n\\* amazon_payments -\n\nPayments made via Amazon Payments.\n\\* gcash - \\* card -\n\nCard based payment including credit cards and debit cards. Details about the card can be obtained from the card resource.\n\\* online_banking_poland - \\* trustly -\n\nTrustly\n\\* kbc_payment_button -\n\nKBC Payment Button\n\\* alipay_hk - \\* 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" ], + "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" ], "example" : null }, "gateway_account_id" : { @@ -40388,7 +40420,7 @@ "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\\* card -\n\ncard\n\\* twint -\n\nPayments made via Twint\n\\* dotpay -\n\ndotpay\n\\* faster_payments - \\* upi -\n\nupi\n\\* kbc_payment_button -\n\nKBC Payment Button\n\\* klarna -\n\nPayments made via Klarna.\n\\* payme -\n\nPayments made via PayMe\n\\* google_pay -\n\ngoogle_pay\n\\* paypal_express_checkout -\n\npaypal_express_checkout\n\\* pix -\n\nPix\n\\* klarna_pay_now -\n\nKlarna Pay Now\n\\* ideal -\n\nideal\n\\* boleto -\n\nboleto\n\\* wechat_pay -\n\nPayments made via WeChat Pay.\n\\* after_pay -\n\nPayments made via Afterpay\n\\* grab_pay -\n\nPayments made via GrabPay\n\\* direct_debit -\n\ndirect_debit\n\\* sepa_instant_transfer - \\* bancontact -\n\nbancontact\n\\* kakao_pay -\n\nPayments made via Kakao Pay.\n\\* south_korean_cards - \\* swish -\n\nPayments made via Swish\n\\* go_pay -\n\nPayments made via GoPay\n\\* trustly -\n\nTrustly\n\\* naver_pay -\n\nPayments made via Naver Pay.\n\\* stablecoin -\n\nPayments made via Stablecoin.\n\\* venmo - \\* alipay -\n\nPayments made via Alipay.\n\\* pay_to - \\* pay_co -\n\nPayments made via PayCo\n\\* cash_app_pay -\n\nPayments made via Cash App Pay.\n\\* alipay_hk - \\* netbanking_emandates -\n\nnetbanking_emandates\n\\* paypay - \\* payconiq_by_bancontact -\n\nPayments made via Payconiq by Bancontact.\n\\* electronic_payment_standard -\n\nElectronic Payment Standard\n\\* pay_by_bank -\n\nPay By Bank\n\\* apple_pay -\n\napple_pay\n\\* online_banking_poland - \\* gcash - \\* giropay -\n\ngiropay\n\\* sofort -\n\nsofort\n\\* amazon_payments -\n\namazon_payments\n\\* revolut_pay -\n\nPayments made via Revolut Pay.\n", - "enum" : [ "card", "ideal", "sofort", "bancontact", "google_pay", "dotpay", "giropay", "apple_pay", "upi", "netbanking_emandates", "paypal_express_checkout", "direct_debit", "boleto", "venmo", "amazon_payments", "pay_to", "faster_payments", "sepa_instant_transfer", "klarna_pay_now", "online_banking_poland", "payconiq_by_bancontact", "electronic_payment_standard", "kbc_payment_button", "pay_by_bank", "trustly", "stablecoin", "kakao_pay", "naver_pay", "revolut_pay", "cash_app_pay", "wechat_pay", "alipay", "twint", "go_pay", "grab_pay", "pay_co", "after_pay", "swish", "payme", "pix", "klarna", "alipay_hk", "paypay", "gcash", "south_korean_cards" ], + "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" ], "example" : null }, "reference_id" : { @@ -43480,8 +43512,8 @@ "tax_override_reason" : { "type" : "string", "deprecated" : false, - "description" : "The reason for exempting the invoice from tax. (Applicable only for exempted invoices.).\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\\* 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", - "enum" : [ "id_exempt", "customer_exempt", "export" ], + "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" : { @@ -43595,6 +43627,13 @@ "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.

", + "example" : null + }, "credit_note" : { "type" : "object", "deprecated" : false, @@ -44251,6 +44290,17 @@ }, "example" : null }, + "proration_mode" : { + "type" : "array", + "items" : { + "type" : "string", + "deprecated" : false, + "description" : "Proration mode for the line item.\n", + "enum" : [ "reset", "delta", "service_period_revision", "adjusted_term" ], + "example" : null + }, + "example" : null + }, "created_at" : { "type" : "array", "description" : "", @@ -46260,14 +46310,14 @@ "deprecated" : false, "example" : "old_inv_001", "properties" : { - "is" : { + "in" : { "type" : "string", - "minLength" : 1, + "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, - "in" : { + "is" : { "type" : "string", - "pattern" : "^\\[(.*)(,.*)*\\]$", + "minLength" : 1, "example" : null } } @@ -46290,14 +46340,14 @@ "description" : "This parameter is used to identify the PRN in the system and retrieve its corresponding payment information. \\*\\*Note\\*\\*: To retrieve the PRN, the API requires either the invoice ID or the payment reference number to be provided by the user. If both values are missing, an error will be returned by the API.\n", "example" : "001234", "properties" : { - "is" : { + "in" : { "type" : "string", - "minLength" : 1, + "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, - "in" : { + "is" : { "type" : "string", - "pattern" : "^\\[(.*)(,.*)*\\]$", + "minLength" : 1, "example" : null } } @@ -47677,7 +47727,7 @@ }, "/invoices/{invoice-id}/pdf" : { "post" : { - "summary" : "Retrieve Invoice as PDF", + "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" : [ { @@ -49159,6 +49209,17 @@ "example" : null }, "example" : null + }, + "proration_mode" : { + "type" : "array", + "items" : { + "type" : "string", + "deprecated" : false, + "description" : "Proration mode for the line item.\n", + "enum" : [ "reset", "delta", "service_period_revision", "adjusted_term" ], + "example" : null + }, + "example" : null } }, "required" : [ "description" ], @@ -49701,7 +49762,7 @@ }, "/credit_notes/{credit-note-id}/delete" : { "post" : { - "summary" : "Delete a credit Note", + "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" : [ { @@ -60600,7 +60661,7 @@ "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" ], + "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" ], "example" : null }, "reference_id" : { @@ -61432,7 +61493,7 @@ "/transactions" : { "get" : { "summary" : "List transactions", - "description" : "Lists all the transactions.\n", + "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.

", "operationId" : "list_transactions", "parameters" : [ { "name" : "chargebee-request-origin-device", @@ -61727,28 +61788,28 @@ "properties" : { "is" : { "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 ", - "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" ], + "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 ", + "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" ], "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 ", - "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" ], + "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 ", + "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" ], "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 ", - "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" ], - "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)(,(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))*\\]$", + "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 ", + "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" ], + "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)(,(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))*\\]$", "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 ", - "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" ], - "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)(,(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))*\\]$", + "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 ", + "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" ], + "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)(,(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))*\\]$", "example" : null } } @@ -61944,7 +62005,7 @@ }, { "name" : "date", "in" : "query", - "description" : "optional, timestamp(UTC) in seconds filter\n\nIndicates when this transaction occurred.\n**Supported operators :**\nafter, before, on, between\n\n**Example →**\n*date\\[before\\] = \"1435054328\"*\n", + "description" : "

optional, timestamp(UTC) in seconds filter

\n

Indicates 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

\n

Example →\ndate[before] = "1435054328"

", "required" : false, "deprecated" : false, "style" : "deepObject", @@ -64450,7 +64511,7 @@ }, "/hosted_pages/extend_subscription" : { "post" : { - "summary" : "Extend Subscription", + "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:

Do not embed the hosted page in your own iframe.

", "operationId" : "extend_subscription", "parameters" : [ { @@ -67622,7 +67683,7 @@ }, "/hosted_pages/collect_now" : { "post" : { - "summary" : "Collect Now", + "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')).

", "operationId" : "collect_now", "parameters" : [ { @@ -67932,7 +67993,7 @@ }, "/hosted_pages/checkout_gift" : { "post" : { - "summary" : "Checkout Gift subscription", + "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).

Gifter customer resource lookup and creation

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.

Gift receiver customer resource lookup and creation

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

", "operationId" : "checkout_gift_subscription", "parameters" : [ { @@ -68595,7 +68656,7 @@ }, "/hosted_pages/claim_gift" : { "post" : { - "summary" : "Claim a Gift subscription", + "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" : [ { @@ -69430,7 +69491,7 @@ }, "/hosted_pages/retrieve_agreement_pdf" : { "post" : { - "summary" : "Retrieve Direct Debit Agreement PDF", + "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" : [ { @@ -69890,7 +69951,7 @@ }, "/hosted_pages/manage_payment_sources" : { "post" : { - "summary" : "Manage Payment Sources", + "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:

Do not embed the hosted page in your own iframe.

", "operationId" : "manage_payment_sources", "parameters" : [ { @@ -72678,7 +72739,7 @@ "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" ], + "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" ], "example" : null }, "reference_id" : { @@ -73262,7 +73323,7 @@ }, "/subscriptions/{subscription-id}/regenerate_invoice_estimate" : { "post" : { - "summary" : "Regenerate Invoice Estimate", + "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:

Response

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

", "operationId" : "regenerate_invoice_estimate", "parameters" : [ { @@ -86689,7 +86750,7 @@ }, "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.

", + "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.

", "items" : { "type" : "integer", "format" : "int64", @@ -87740,7 +87801,7 @@ }, "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.

", + "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.

", "items" : { "type" : "integer", "format" : "int64", @@ -88133,7 +88194,7 @@ }, "/addons/copy" : { "post" : { - "summary" : "Copy an Addon", + "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" : [ { @@ -89266,7 +89327,7 @@ }, "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.

", + "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.

", "items" : { "type" : "integer", "format" : "int64", @@ -90630,7 +90691,7 @@ }, "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.

", + "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.

", "items" : { "type" : "integer", "format" : "int64", @@ -91600,14 +91661,14 @@ "deprecated" : false, "example" : "day-pass-USD", "properties" : { - "is" : { + "in" : { "type" : "string", - "minLength" : 1, + "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, - "in" : { + "is" : { "type" : "string", - "pattern" : "^\\[(.*)(,.*)*\\]$", + "minLength" : 1, "example" : null } } @@ -100894,7 +100955,7 @@ }, "/time_machines/{time-machine-name}/start_afresh" : { "post" : { - "summary" : "Start Afresh", + "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" : [ { @@ -101162,7 +101223,7 @@ }, "/exports/customers" : { "post" : { - "summary" : "Export Customers", + "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" : [ { @@ -101280,7 +101341,7 @@ "type" : "string", "default" : "data", "deprecated" : false, - "description" : "Determines the format of the data. Returns the export type based on the selected value.\n\\* data -\n\nDownload your current data in CSV.\n\\* import_friendly_data -\n\nDownload import friendly data in CSV. This CSV can be used to perform [bulk operations](https://www.chargebee.com/docs/bulk-operations.html)\n.\n", + "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.

\n* import_friendly_data -

Provides a .csv file whose columns match the customer schema. This file format can be readily imported through the UI by using Bulk Operations.

", "enum" : [ "data", "import_friendly_data" ], "example" : null }, @@ -101657,7 +101718,7 @@ "auto_close_invoices" : { "type" : "object", "deprecated" : false, - "description" : "Override for this customer, the \\[site-level setting\\](https://www.chargebee.com/docs/2.0/metered_billing.html#configuring-metered-billing) for auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute is also available at the \\[subscription level\\](/docs/api/subscriptions/subscription-object#auto_close_invoices) which takes precedence.\n", + "description" : "Override for this customer, the \\[site-level setting\\](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing) for auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute is also available at the \\[subscription level\\](/docs/api/subscriptions/subscription-object#auto_close_invoices) which takes precedence.\n", "example" : "true", "properties" : { "is" : { @@ -101926,7 +101987,7 @@ }, "/exports/transactions" : { "post" : { - "summary" : "Export Transactions", + "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" : [ { @@ -102203,28 +102264,28 @@ "properties" : { "is" : { "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 ", - "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" ], + "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 ", + "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" ], "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 ", - "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" ], + "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 ", + "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" ], "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 ", - "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" ], - "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)(,(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))*\\]$", + "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 ", + "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" ], + "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)(,(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))*\\]$", "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 ", - "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" ], - "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)(,(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))*\\]$", + "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 ", + "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" ], + "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)(,(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))*\\]$", "example" : null } } @@ -102719,7 +102780,7 @@ }, "/exports/invoices" : { "post" : { - "summary" : "Export Invoices", + "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" : [ { @@ -103816,7 +103877,7 @@ }, "/exports/deferred_revenue" : { "post" : { - "summary" : "Export Deferred Revenue Reports", + "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" : [ { @@ -105048,7 +105109,7 @@ "auto_close_invoices" : { "type" : "object", "deprecated" : false, - "description" : "

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.

", + "description" : "

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.

", "example" : "true", "properties" : { "is" : { @@ -105446,7 +105507,7 @@ "auto_close_invoices" : { "type" : "object", "deprecated" : false, - "description" : "Override for this customer, the \\[site-level setting\\](https://www.chargebee.com/docs/2.0/metered_billing.html#configuring-metered-billing) for auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute is also available at the \\[subscription level\\](/docs/api/subscriptions/subscription-object#auto_close_invoices) which takes precedence.\n", + "description" : "Override for this customer, the \\[site-level setting\\](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing) for auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute is also available at the \\[subscription level\\](/docs/api/subscriptions/subscription-object#auto_close_invoices) which takes precedence.\n", "example" : "true", "properties" : { "is" : { @@ -105724,7 +105785,7 @@ }, "/exports/revenue_recognition" : { "post" : { - "summary" : "Export Revenue Recognition Reports", + "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" : [ { @@ -106956,7 +107017,7 @@ "auto_close_invoices" : { "type" : "object", "deprecated" : false, - "description" : "

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.

", + "description" : "

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.

", "example" : "true", "properties" : { "is" : { @@ -107354,7 +107415,7 @@ "auto_close_invoices" : { "type" : "object", "deprecated" : false, - "description" : "Override for this customer, the \\[site-level setting\\](https://www.chargebee.com/docs/2.0/metered_billing.html#configuring-metered-billing) for auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute is also available at the \\[subscription level\\](/docs/api/subscriptions/subscription-object#auto_close_invoices) which takes precedence.\n", + "description" : "Override for this customer, the \\[site-level setting\\](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing) for auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute is also available at the \\[subscription level\\](/docs/api/subscriptions/subscription-object#auto_close_invoices) which takes precedence.\n", "example" : "true", "properties" : { "is" : { @@ -107632,7 +107693,7 @@ }, "/exports/credit_notes" : { "post" : { - "summary" : "Export Credit Notes", + "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" : [ { @@ -108530,7 +108591,7 @@ }, "/exports/coupons" : { "post" : { - "summary" : "Export Coupons", + "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" : [ { @@ -108683,14 +108744,14 @@ "description" : "List of itemPrice ids for which these coupons are applicable.\n", "example" : "day-pass-USD", "properties" : { - "is" : { + "in" : { "type" : "string", - "minLength" : 1, + "pattern" : "^\\[(.*)(,.*)*\\]$", "example" : null }, - "in" : { + "is" : { "type" : "string", - "pattern" : "^\\[(.*)(,.*)*\\]$", + "minLength" : 1, "example" : null } } @@ -109107,7 +109168,7 @@ }, "/exports/orders" : { "post" : { - "summary" : "Export Orders", + "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" : [ { @@ -109995,7 +110056,7 @@ }, "/exports/addons" : { "post" : { - "summary" : "Export Addons", + "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" : [ { @@ -110621,7 +110682,7 @@ }, "/exports/subscriptions" : { "post" : { - "summary" : "Export Subscriptions", + "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" : [ { @@ -110739,7 +110800,7 @@ "type" : "string", "default" : "data", "deprecated" : false, - "description" : "Determines the format of the data. Returns the export type based on the selected value.\n\\* data -\n\nDownload your current data in CSV.\n\\* import_friendly_data -\n\nDownload import friendly data in CSV. This CSV can be used to perform [bulk operations](https://www.chargebee.com/docs/bulk-operations.html)\n.\n", + "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.

\n* import_friendly_data -

Provides a .csv file whose columns match the subscription schema. This file format can be readily imported through the UI by using Bulk Operations.

", "enum" : [ "data", "import_friendly_data" ], "example" : null }, @@ -111221,7 +111282,7 @@ "auto_close_invoices" : { "type" : "object", "deprecated" : false, - "description" : "

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.

", + "description" : "

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.

", "example" : "true", "properties" : { "is" : { @@ -111265,6 +111326,20 @@ "example" : null } } + }, + "decommissioned" : { + "type" : "object", + "deprecated" : false, + "description" : "Specifies whether a cancelled subscription is decommissioned or not\n", + "example" : "true", + "properties" : { + "is" : { + "type" : "string", + "format" : "boolean", + "enum" : [ "true", "false" ], + "example" : null + } + } } }, "example" : null @@ -111409,7 +111484,7 @@ }, "/exports/plans" : { "post" : { - "summary" : "Export Plans", + "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" : [ { @@ -112711,7 +112786,7 @@ "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" ], + "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" ], "example" : null }, "success_url" : { @@ -113025,7 +113100,7 @@ "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" ], + "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" ], "example" : null }, "success_url" : { @@ -113844,7 +113919,7 @@ }, "/in_app_subscriptions/{in-app-subscription-app-id}/retrieve" : { "post" : { - "summary" : "Retrieve Store Subscription", + "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.

Path Parameter

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.

    \n
  • Apple App Store: To obtain the value for {in_app_subscription_app_id}, click View Keys within the Sync Overview page of the web app and use the value of generated App ID for this parameter. See detailed steps here.
    • \n
  • Google Play Store: To obtain the value for {in_app_subscription_app_id}, click Set up notifications within the Sync Overview page of the web app and use the value of generated App ID for this parameter. See detailed steps here.
    • \n
", "operationId" : "retrieve_store_subscription", "parameters" : [ { @@ -114118,7 +114193,7 @@ }, "/in_app_subscriptions/{in-app-subscription-app-id}/import_receipt" : { "post" : { - "summary" : "Import Receipt", + "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.

Apple App Store

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

    \n
  • Integrate Chargebee with your Apple App Store account using your shared secret from Apple.
    • \n
  • It is strongly recommended to use this endpoint to import historical in-app subscriptions only.
    • \n
  • You must import Apple App Store products using Chargebee's user interface before importing receipts using this API.
    • \n

Chargebee validates the receipt with Apple App Store and does the following once validation succeeds:

Subscriptions

Subscriptions are imported as follows:

    \n
  1. A subscription is imported for every unique value of the original_transaction_id in the Apple receipt.\nNote: This is not done for original_transaction_ids for which a subscription already exists in Chargebee.
    2. \n
  2. Each subscription imported has the following attributes set:\n
      \n
    • id set to original_transaction_id.
      • \n
    • start_date set to the earliest purchase_date_ms.
      • \n
    • current_term_start set to latest purchase_date_ms.
      • \n
    • current_term_end set to expires_date_ms of the same Latest_receipt_info element with the latest purchase_date_ms.
      • \n
    • plan_id set to product_id.
      • \n
    • status set to in_trial if there is only one element of Latest_receipt_info with the original_transaction_id and the field is_trial_period is true, then consider the subscription is currently in trial. No invoices are created for this subscription.
      • \n
    \n
    3. \n

Invoices for the subscription

Invoices are imported as follows:

    \n
  1. An invoice is imported to Chargebee for every element of the array Latest_receipt_info which has is_trial_period as false.
    2. \n
  2. Each imported invoice has the subscription_id set to original_transaction_id.
    3. \n

Transactions for the invoices

A transaction is imported for each invoice with the following details:

    \n
  1. reference_number set to the transaction_id.
    2. \n
  2. payment_method set to apple_store.
    3. \n
Google Play 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

    \n
  • Integrate Chargebee with your Google Play Store account using your service account credentials JSON.
    • \n
  • It is strongly recommended to use this endpoint to import historical in-app subscriptions only.
    • \n
  • It is recommended to pass only the latest purchase token. If any other purchase token is passed instead of the latest one, there is a possibility of returning incorrect transaction details. If an expired purchase token is passed, then it returns an error.
    • \n
  • The Google purchase token is valid from subscription signup until 60 days after subscription expiration. After the token expires, an API request to Google Developers API returns an error.
    • \n

Chargebee validates the purchase token with Google Play Store and does the following once validation succeeds:

Subscriptions

    \n
  • \n

    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).

    \n
    • \n
  • \n

    Each subscription imported has the following attributes set:

    \n
      \n
    • \n

      id set to a unique identifier generated by Chargebee and mapped to the token and latestOrderId of the SubscriptionPurchaseV2 object from Google response.

      \n
      • \n
    • \n

      start_date set to the earliest SubscriptionPurchaseV2.startTime.

      \n
      • \n
    • \n

      current_term_start set to latest SubscriptionPurchaseV2.startTime.

      \n
      • \n
    • \n

      current_term_end set to expiryTime of the same SubscriptionPurchaseV2 element with the latest purchase.

      \n
      • \n
    • \n

      plan_id set to the concatenation of product[id] and priceCurrencyCode from Google.

      \n
      • \n
    • \n

      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.

      \n
      • \n
    \n
    • \n

Invoices for the subscription

Invoices are imported as follows:

    \n
  • \n

    An invoice is imported to Chargebee for every new subscription and renewal of an existing subscription using latestOrderId.

    \n
    • \n
  • \n

    Each imported invoice has the subscription_id set to a unique identifier generated by Chargebee and mapped to the token and latestOrderId.

    \n
    • \n

Transactions for the invoices

A transaction is imported for each invoice with the following details:

    \n
  • \n

    transaction.reference_number is set to the latestOrderId.

    \n
    • \n
  • \n

    transaction.payment_method is set to play_store.

    \n
    • \n

Path Parameter

{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.

", "operationId" : "import_receipt", "parameters" : [ { @@ -114440,7 +114515,7 @@ }, "/in_app_subscriptions/{in-app-subscription-app-id}/import_subscription" : { "post" : { - "summary" : "Import Subscription Without Receipt", + "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:

    \n
  • Subscriptions cannot be imported from the Google Play Store without a receipt or token. Therefore; Chargebee does not allow you to use this API for the Google Play Store.
    • \n
  • Enable V1 notifications in the Apple App Store for subscriptions created without receipts. Chargebee depends on receipt data to update subscription statuses. Apple's V2 notifications do not have receipt information; therefore, Chargebee cannot process V2 notifications for subscriptions imported without receipts. Learn more about app store notifications and notification URL configuration.
    • \n

Apple App Store

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

    \n
  • \n

    Integrate Chargebee with your Apple App Store account using your shared secret from Apple.

    \n
    • \n
  • \n

    It is strongly recommended to use this endpoint to create a historic In-App subscription only.

    \n
    • \n
  • \n

    You must import App Store products using Chargebee's user interface before importing receipts using this API.

    \n
    • \n

Chargebee validates the application ID with Apple App Store and does the following once validation succeeds:

Subscription

    \n
  1. \n

    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.

    \n
    2. \n
  2. \n

    Each subscription imported has the following attribute set:

    \n
      \n
    • \n

      id set to subscription[id] . This subscription[id] is the original_transaction_id in the receipts.

      \n
      • \n
    • \n

      start_date set to subscription[start_date]. You need to provide this information from the oldest Latest_receipt_info.purchase_date_ms.

      \n
      • \n
    • \n

      term_start set to subscription[term_start]. You need to provide this information from the oldest Latest_receipt_info.purchase_date_ms).

      \n
      • \n
    • \n

      term_end set to subscription[term_end]. You need to provide this information from the oldest Latest_receipt_info.expires_date_ms.

      \n
      • \n
    • \n

      plan_id set to subscription[product_id] + subscription[currency_code]. You need to provide this information from the Latest_receipt_info.product_id.

      \n
      • \n
    • \n

      Chargebee records the subscription in a Trial state if the is_trial_period is true.

      \n
      • \n
    • \n

      Chargebee records the subscription in a Canceled state if the term_end is less than the System.currentTime().

      \n
      • \n
    \n
    3. \n

Invoice for the subscription

    \n
  1. The payment is recorded against the subscription invoice.
    2. \n

Transactions for the invoice

    \n
  1. The associated transaction is updated with the following details:
    2. \n

Path Parameter

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.

", "operationId" : "import_subscription_without_receipt", "parameters" : [ { @@ -114798,7 +114873,7 @@ }, "/in_app_subscriptions/{in-app-subscription-app-id}/process_purchase_command" : { "post" : { - "summary" : "Process Purchase Command", + "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.

Apple App Store

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

    \n
  • Integrate Chargebee with your Apple App Store account using your shared secret from Apple.
    • \n
  • It is strongly recommended to use this endpoint to notify Chargebee of new purchases only.
    • \n
  • For updates to existing subscriptions, we recommend that you configure Apple App Store to send server notifications to Chargebee.
    • \n

Chargebee validates the receipt with Apple App Store and does the following once validation succeeds:

    \n
  1. Look for plan_id that matches the concatenation of product[id] and priceCurrencyCode from Apple, and if not found, create such a plan.
    2. \n
  2. Create/update a subscription:
    3. \n
    \n
  • \n

    If the token is for a new purchase, a new subscription is created for the plan described in the previous step. The subscription has the following details:

    \n
    • \n
  • \n

    id set to original_transaction_id

    \n
    • \n
  • \n

    start_date set to responseBody.Latest_receipt_info.purchase_date_ms

    \n
    • \n
  • \n

    current_term_end set to responseBody.Latest_receipt_info.expires_date_ms

    \n
    • \n
  • \n

    Instead, if the receipt belongs to an existing subscription in Chargebee, it is updated to reflect the current state of the subscription at Apple.

    \n
    • \n
    \n
  1. The payment is recorded against the subscription invoice. The associated transaction is updated with the following details:
    2. \n
Google Play Store

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

    \n
  • Integrate Chargebee with your Google Play Store account using the service account credentials JSON.
    • \n
  • It is strongly recommended to use this endpoint to notify Chargebee of new purchases only.
    • \n
  • For updates to existing subscriptions, we recommend that you configure Chargebee to receive Google's server notifications through pub/sub topic. Learn more.
    • \n

Chargebee validates the token with Google Play Store and does the following once validation succeeds:

    \n
  1. Look for plan_id that matches the concatenation of product[id] and priceCurrencyCode from Google, and if not found, create such a plan.
    2. \n
  2. Create/update a subscription:
    3. \n
    \n
  • \n

    If the token is for a new purchase, a new subscription is created for the plan described in the previous step. The subscription has the following details:

    \n
    • \n
  • \n

    id set to set to unique identifier generated by Chargebee and mapped to token of the SubscriptionPurchase object from Google response.

    \n
    • \n
  • \n

    start_date set to SubscriptionPurchase.startTimeMillis.

    \n
    • \n
  • \n

    current_term_end set to SubscriptionPurchase.expiryTimeMillis.

    \n
    • \n
  • \n

    Instead, if the token belongs to an existing subscription in Chargebee, it is updated to reflect the current state of the subscription at Google.

    \n
    • \n
    \n
  1. The payment is recorded against the subscription invoice. The associated transaction is updated with the following details:
    2. \n

Path Parameter

{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.

", "operationId" : "process_purchase_command", "parameters" : [ { @@ -128143,7 +128218,7 @@ "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.

", + "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.

", "minimum" : 0, "example" : null }, @@ -128911,6 +128986,266 @@ "required" : [ "created_at", "error_detail", "id", "operation_type", "resource", "result", "status", "updated_at" ], "example" : null }, + "AsyncResponse" : { + "type" : "object", + "properties" : { + "api_version" : { + "type" : "string", + "deprecated" : false, + "maxLength" : 10, + "example" : null + }, + "created_at" : { + "type" : "integer", + "format" : "unix-time", + "deprecated" : false, + "example" : null + }, + "completed_at" : { + "type" : "integer", + "format" : "unix-time", + "deprecated" : false, + "example" : null + }, + "status" : { + "type" : "string", + "deprecated" : false, + "enum" : [ "success", "failed" ], + "example" : null + }, + "result" : { + "type" : "object", + "additionalProperties" : true, + "deprecated" : false, + "example" : null + }, + "request" : { + "type" : "object", + "deprecated" : false, + "properties" : { + "id" : { + "type" : "string", + "deprecated" : false, + "maxLength" : 100, + "example" : null + }, + "resource" : { + "type" : "string", + "deprecated" : false, + "maxLength" : 100, + "example" : null + }, + "operation_type" : { + "type" : "string", + "deprecated" : false, + "maxLength" : 100, + "example" : null + }, + "method" : { + "type" : "string", + "deprecated" : false, + "maxLength" : 10, + "example" : null + }, + "uri" : { + "type" : "string", + "deprecated" : false, + "maxLength" : 512, + "example" : null + }, + "idempotency_key" : { + "type" : "string", + "deprecated" : false, + "maxLength" : 250, + "example" : null + } + }, + "required" : [ "id" ], + "example" : null + }, + "error_detail" : { + "type" : "object", + "deprecated" : false, + "properties" : { + "message" : { + "type" : "string", + "deprecated" : false, + "maxLength" : 500, + "example" : null + }, + "type" : { + "type" : "string", + "deprecated" : false, + "maxLength" : 100, + "example" : null + }, + "api_error_code" : { + "type" : "string", + "deprecated" : false, + "maxLength" : 100, + "example" : null + }, + "error_code" : { + "type" : "string", + "deprecated" : false, + "maxLength" : 100, + "example" : null + }, + "error_msg" : { + "type" : "string", + "deprecated" : false, + "maxLength" : 250, + "example" : null + }, + "http_status_code" : { + "type" : "string", + "deprecated" : false, + "maxLength" : 100, + "example" : null + } + }, + "example" : null + } + }, + "required" : [ "status" ], + "example" : null + }, + "AsyncResponseList" : { + "type" : "object", + "properties" : { + "list" : { + "type" : "array", + "deprecated" : false, + "items" : { + "type" : "object", + "deprecated" : false, + "properties" : { + "api_version" : { + "type" : "string", + "deprecated" : false, + "maxLength" : 10, + "example" : null + }, + "created_at" : { + "type" : "integer", + "format" : "unix-time", + "deprecated" : false, + "example" : null + }, + "completed_at" : { + "type" : "integer", + "format" : "unix-time", + "deprecated" : false, + "example" : null + }, + "status" : { + "type" : "string", + "deprecated" : false, + "enum" : [ "success", "failed" ], + "example" : null + }, + "request" : { + "type" : "object", + "deprecated" : false, + "properties" : { + "id" : { + "type" : "string", + "deprecated" : false, + "maxLength" : 100, + "example" : null + }, + "resource" : { + "type" : "string", + "deprecated" : false, + "maxLength" : 100, + "example" : null + }, + "operation_type" : { + "type" : "string", + "deprecated" : false, + "maxLength" : 100, + "example" : null + }, + "method" : { + "type" : "string", + "deprecated" : false, + "maxLength" : 10, + "example" : null + }, + "uri" : { + "type" : "string", + "deprecated" : false, + "maxLength" : 512, + "example" : null + }, + "idempotency_key" : { + "type" : "string", + "deprecated" : false, + "maxLength" : 250, + "example" : null + } + }, + "required" : [ "id" ], + "example" : null + }, + "error_detail" : { + "type" : "object", + "deprecated" : false, + "properties" : { + "message" : { + "type" : "string", + "deprecated" : false, + "maxLength" : 500, + "example" : null + }, + "type" : { + "type" : "string", + "deprecated" : false, + "maxLength" : 100, + "example" : null + }, + "api_error_code" : { + "type" : "string", + "deprecated" : false, + "maxLength" : 100, + "example" : null + }, + "error_code" : { + "type" : "string", + "deprecated" : false, + "maxLength" : 100, + "example" : null + }, + "error_msg" : { + "type" : "string", + "deprecated" : false, + "maxLength" : 250, + "example" : null + }, + "http_status_code" : { + "type" : "string", + "deprecated" : false, + "maxLength" : 100, + "example" : null + } + }, + "example" : null + }, + "result" : { + "type" : "object", + "additionalProperties" : true, + "deprecated" : false, + "example" : null + } + }, + "required" : [ "status" ], + "example" : null + }, + "example" : null + } + }, + "example" : null + }, "AuthorizationSucceededEvent" : { "type" : "object", "properties" : { @@ -129794,6 +130129,25 @@ "enum" : [ "invoice_immediately", "add_to_unbilled_charges" ], "example" : null }, + "ColumnDefinition" : { + "type" : "object", + "properties" : { + "column_name" : { + "type" : "string", + "deprecated" : false, + "maxLength" : 100, + "example" : null + }, + "data_type" : { + "type" : "string", + "deprecated" : false, + "enum" : [ "number", "string" ], + "example" : null + } + }, + "required" : [ "column_name", "data_type" ], + "example" : null + }, "Comment" : { "type" : "object", "description" : "Comments are additional information that you can add to your resources. Comments can be added to provide context for any operation that was performed.\n\nWhen you make an API call on any resource eg., Subscriptions -\\> Change term end, you can add more context to that operation by calling the comments API as a follow up call.\n\nBesides the user generated comments, Chargebee also generates \"System\" comments when a change for a resource happens at the backend. These comments are all read-only.\n", @@ -131689,6 +132043,13 @@ "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" ], @@ -132376,6 +132737,33 @@ }, "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, @@ -133060,6 +133448,12 @@ "deprecated" : false, "maxLength" : 100, "example" : null + }, + "proration_mode" : { + "type" : "string", + "deprecated" : false, + "enum" : [ "reset", "delta", "service_period_revision", "adjusted_term" ], + "example" : null } }, "required" : [ "date_from", "date_to", "description", "entity_type", "is_taxed", "unit_amount" ], @@ -134047,7 +134441,7 @@ "auto_close_invoices" : { "type" : "boolean", "deprecated" : false, - "description" : "Override for this customer, the [site-level setting](https://www.chargebee.com/docs/2.0/metered_billing.html#configuring-metered-billing)\nfor auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute is also available at the [subscription level](/docs/api/subscriptions/subscription-object#auto_close_invoices)\nwhich takes precedence.\n", + "description" : "Override for this customer, the [site-level setting](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing)\nfor auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute is also available at the [subscription level](/docs/api/subscriptions/subscription-object#auto_close_invoices)\nwhich takes precedence.\n", "example" : null }, "channel" : { @@ -134490,7 +134884,7 @@ "type" : "string", "deprecated" : false, "description" : "Type of payment source\n\\* grab_pay -\n\nPayments made via GrabPay\n\\* go_pay -\n\nPayments made via GoPay\n\\* google_pay -\n\nPayments made via Google Pay.\n\\* after_pay -\n\nPayments made via Afterpay\n\\* pix -\n\nPayments made via Pix\n\\* pay_by_bank -\n\nPay By Bank\n\\* sofort -\n\nPayments made via Sofort.\n\\* twint -\n\nPayments made via Twint\n\\* netbanking_emandates -\n\nNetbanking (eMandates) Payments.\n\\* apple_pay -\n\nPayments made via Apple Pay.\n\\* unionpay -\n\nPayments made via UnionPay.\n\\* giropay -\n\nPayments made via giropay.\n\\* direct_debit -\n\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\\* upi -\n\nUPI Payments.\n\\* revolut_pay -\n\nPayments made via Revolut Pay.\n\\* stablecoin -\n\nPayments made via Stablecoin.\n\\* alipay -\n\nPayments made via Alipay. \nThis payment source is deprecated.\n\\* payme -\n\nPayments made via PayMe\n\\* pay_to -\n\nPayments made via PayTo\n\\* pay_co -\n\nPayments made via PayCo\n\\* kakao_pay -\n\nPayments made via Kakao Pay.\n\\* wechat_pay -\n\nPayments made via WeChat Pay. \nThis payment source is deprecated.\n\\* sepa_instant_transfer -\n\nPayments made via Sepa Instant Transfer\n\\* dotpay -\n\nPayments made via Dotpay.\n\\* klarna -\n\nPayments made via Klarna.\n\\* paypal_express_checkout -\n\nPayments made via PayPal Express Checkout.\n\\* ideal -\n\nPayments made via iDEAL.\n\\* electronic_payment_standard -\n\nElectronic Payment Standard\n\\* generic -\n\nPayments made via Generic Payment Method.\n\\* klarna_pay_now -\n\nPayments made via Klarna Pay Now\n\\* faster_payments -\n\nPayments made via Faster Payments\n\\* swish -\n\nPayments made via Swish\n\\* venmo -\n\nPayments made via Venmo\n\\* payconiq_by_bancontact -\n\nPayments made via Payconiq by Bancontact.\n\\* naver_pay -\n\nPayments made via Naver Pay.\n\\* automated_bank_transfer -\n\nRepresents virtual bank account using which the payment will be done.\n\\* amazon_payments -\n\nPayments made via Amazon Payments.\n\\* gcash - \\* card -\n\nCard based payment including credit cards and debit cards. Details about the card can be obtained from the card resource.\n\\* online_banking_poland -\n\nPayments made via Online Banking Poland\n\\* trustly -\n\nTrustly\n\\* kbc_payment_button -\n\nKBC Payment Button\n\\* alipay_hk - \\* 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" ], + "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" ], "example" : null }, "gateway" : { @@ -135135,7 +135529,7 @@ "type" : "string", "default" : "auto_collect", "deprecated" : false, - "enum" : [ "auto_collect", "offline", "direct_debit" ], + "enum" : [ "auto_collect", "offline", "direct_debit", "real_time_payments" ], "example" : null }, "DunningUpdatedEvent" : { @@ -136257,6 +136651,13 @@ "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" ], @@ -137065,6 +137466,13 @@ "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" ], @@ -137972,6 +138380,13 @@ "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" ], @@ -138775,6 +139190,13 @@ "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" ], @@ -140476,12 +140898,6 @@ "enum" : [ "available", "exhausted", "scheduled", "in_grace_period" ], "example" : null }, - "metadata" : { - "type" : "string", - "deprecated" : false, - "maxLength" : 65000, - "example" : null - }, "grant_source" : { "type" : "string", "deprecated" : false, @@ -140511,6 +140927,12 @@ "deprecated" : false, "enum" : [ "credit_unit" ], "example" : null + }, + "metadata" : { + "type" : "object", + "additionalProperties" : true, + "deprecated" : false, + "example" : null } }, "required" : [ "balance", "effective_from", "expired_amount", "expires_at", "grant_source", "granted_amount", "hold_amount", "id", "rolled_over_amount", "status", "used_amount", "voided_amount" ], @@ -140684,7 +141106,7 @@ }, "HostedPage" : { "type" : "object", - "description" : "Hosted pages are the easiest and most secure way to integrate chargebee with your website. By using hosted pages, you can avoid the sensitive card information passing through your server and be compliant with most of the PCI DSS requirements.\n\nWhen you request for a hosted page, a **secure** and **unique URL** will be returned which you could either embed or redirect depending upon the embed parameter value that you had passed.\n\nSpecifying **\"embed\"** parameter as **true** allows you to embed the \"hosted page\" in an iframe in your own website. This helps you provide the best experience to your user as they do not have to leave your website to provide card information. There are a few limitations:\n\n* Your site URL must be embedded with HTTPS.\n* Set the appropriate height and width for the iframe to avoid scrolling.\n\nTo use the hosted pages, you must configure **Redirect URL** in the Chargebee web interface under **Hosted Pages Settings** \\> **Configuration**. The configured redirect URL will be called with the following parameters after user had submitted the page.\n\n* **id** - unique identifier of the hosted page resource\n* **state** - succeeded, failed or cancelled\n\nAfter the **Redirect URL** is called by Chargebee with the above parameters, the details of the hosted page can be fetched using [Retrieve a hosted page](/docs/api/v2/pcv-1/hosted_pages/retrieve-a-hosted-page) API. The **content** attribute will have the details about the customer, subscription, card and invoice based on the type of the hosted page.\n\n[Checkout New Subscription](/docs/api/v2/pcv-1/hosted_pages/checkout-new-subscription):\n\n* [Customer](/docs/api/customers/customer-object) - The details about the new customer created.\n* [Subscription](/docs/api/subscriptions/subscription-object) - The details about the new subscription created.\n* [Card](/docs/api/cards/card-object) - The details about the card provided while subscribing.\n* [Invoice](/docs/api/invoices/invoice-object) - The details about the invoice, if one is generated.\n\n[Checkout Existing Subscription](/docs/api/v2/pcv-1/hosted_pages/checkout-existing-subscription):\n\n* [Customer](/docs/api/customers/customer-object) - The updated details of the customer.\n* [Subscription](/docs/api/subscriptions/subscription-object) - The updated details of the subscription.\n* [Card](/docs/api/cards/card-object) - The details about the card provided while subscribing.\n* [Invoice](/docs/api/invoices/invoice-object) - The details about the invoice, if one is generated.\n\n[Update Payment Method](/docs/api/v2/pcv-1/hosted_pages/update-payment-method):\n\n* [Customer](/docs/api/customers/customer-object) - The details about the customer for whom the card was updated.\n* [Card](/docs/api/cards/card-object) - The details about the updated card. It will be present only if the type of payment method is card.\n\nWhen an embedded hosted page is cancelled by your end user, the **content** attribute will have the unmodified details of customer, subscription and card resources.\n", + "description" : "Hosted pages are the easiest and most secure way to integrate chargebee with your website. By using hosted pages, you can avoid the sensitive card information passing through your server and be compliant with most of the PCI DSS requirements.\n\nWhen you request for a hosted page, a **secure** and **unique URL** will be returned which you could either embed or redirect depending upon the embed parameter value that you had passed.\n\nSpecifying **\"embed\"** parameter as **true** allows you to embed the \"hosted page\" in an iframe in your own website. This helps you provide the best experience to your user as they do not have to leave your website to provide card information. There are a few limitations:\n\n* Your site URL must be embedded with HTTPS.\n* Set the appropriate height and width for the iframe to avoid scrolling.\n\nTo use the hosted pages, you must configure **Redirect URL** in the Chargebee web interface under **Hosted Pages Settings** \\> **Configuration**. The configured redirect URL will be called with the following parameters after user had submitted the page.\n\n* **id** - unique identifier of the hosted page resource\n* **state** - succeeded, failed or cancelled\n\nAfter the **Redirect URL** is called by Chargebee with the above parameters, the details of the hosted page can be fetched using [Retrieve a hosted page](/docs/api/v2/pcv-1/hosted_pages/retrieve-a-hosted-page) API. The **content** attribute will have the details about the customer, subscription, card and invoice based on the type of the hosted page.\n\n[Checkout New Subscription](/docs/api/v2/pcv-1/hosted_pages/checkout-new-subscription):\n\n* [Customer](/docs/api/customers/customer-object) - The details about the new customer created.\n* [Subscription](/docs/api/subscriptions/subscription-object) - The details about the new subscription created.\n* [Card](/docs/api/cards/card-object) - The details about the card provided while subscribing.\n* [Invoice](/docs/api/invoices/invoice-object) - The details about the invoice, if one is generated.\n\n[Checkout Existing Subscription](/docs/api/v2/pcv-1/hosted_pages/checkout-existing-subscription):\n\n* [Customer](/docs/api/customers/customer-object) - The updated details of the customer.\n* [Subscription](/docs/api/subscriptions/subscription-object) - The updated details of the subscription.\n* [Card](/docs/api/cards/card-object) - The details about the card provided while subscribing.\n* [Invoice](/docs/api/invoices/invoice-object) - The details about the invoice, if one is generated.\n\n[Manage Payment Sources](/docs/api/v2/pcv-1/hosted_pages/manage-payment-sources):\n\n* [Customer](/docs/api/customers/customer-object) - The details about the customer for whom the card was updated.\n* [Card](/docs/api/cards/card-object) - The details about the updated card. It will be present only if the type of payment method is card.\n\nWhen an embedded hosted page is cancelled by your end user, the **content** attribute will have the unmodified details of customer, subscription and card resources.\n", "properties" : { "id" : { "type" : "string", @@ -141191,6 +141613,33 @@ "maxLength" : 50, "example" : null }, + "exchange_rates" : { + "type" : "array", + "deprecated" : false, + "items" : { + "type" : "object", + "deprecated" : false, + "properties" : { + "currency_code" : { + "type" : "string", + "deprecated" : false, + "maxLength" : 3, + "example" : null + }, + "rate" : { + "type" : "number", + "format" : "decimal", + "deprecated" : false, + "maximum" : 1000000000, + "minimum" : 0.0000000010, + "example" : null + } + }, + "required" : [ "currency_code", "rate" ], + "example" : null + }, + "example" : null + }, "line_items" : { "type" : "array", "deprecated" : false, @@ -141377,6 +141826,13 @@ "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" ], @@ -142144,7 +142600,7 @@ "default" : "auto_collect", "deprecated" : false, "description" : "Types of dunning\n\\* offline -\n\nDunning type is offline.\n\\* direct_debit -\n\nDunning type is direct debit.\n\\* auto_collect -\n\nDunning type is auto collection.\n", - "enum" : [ "auto_collect", "offline", "direct_debit" ], + "enum" : [ "auto_collect", "offline", "direct_debit", "real_time_payments" ], "example" : null }, "created_at" : { @@ -143088,6 +143544,12 @@ "deprecated" : false, "maxLength" : 100, "example" : null + }, + "proration_mode" : { + "type" : "string", + "deprecated" : false, + "enum" : [ "reset", "delta", "service_period_revision", "adjusted_term" ], + "example" : null } }, "required" : [ "date_from", "date_to", "description", "entity_type", "is_taxed", "unit_amount" ], @@ -143765,259 +144227,10 @@ "required" : [ "is_unlimited", "level", "value" ], "example" : null }, - "Meter" : { - "type" : "object", - "properties" : { - "feature_id" : { - "type" : "string", - "deprecated" : false, - "maxLength" : 50, - "example" : null - }, - "id" : { - "type" : "string", - "deprecated" : false, - "maxLength" : 50, - "example" : null - }, - "name" : { - "type" : "string", - "deprecated" : false, - "maxLength" : 50, - "example" : null - }, - "description" : { - "type" : "string", - "deprecated" : false, - "maxLength" : 500, - "example" : null - }, - "type" : { - "type" : "string", - "deprecated" : false, - "enum" : [ "simple", "compound" ], - "example" : null - }, - "status" : { - "type" : "string", - "deprecated" : false, - "enum" : [ "active", "archived", "deleted" ], - "example" : null - }, - "query" : { - "type" : "string", - "deprecated" : false, - "maxLength" : 500, - "example" : null - }, - "meter_strategy" : { - "type" : "string", - "deprecated" : false, - "example" : null - }, - "feature_ids" : { - "type" : "array", - "deprecated" : false, - "items" : { - "type" : "string", - "deprecated" : false, - "maxLength" : 50, - "example" : null - }, - "example" : null - }, - "column_definitions" : { - "type" : "array", - "deprecated" : false, - "items" : { - "type" : "object", - "deprecated" : false, - "properties" : { - "column_name" : { - "type" : "string", - "deprecated" : false, - "maxLength" : 100, - "example" : null - }, - "property_data_type" : { - "type" : "string", - "deprecated" : false, - "enum" : [ "number", "string" ], - "example" : null - }, - "data_type" : { - "type" : "string", - "deprecated" : false, - "enum" : [ "number", "string" ], - "example" : null - } - }, - "required" : [ "column_name", "data_type", "property_data_type" ], - "example" : null - }, - "example" : null - }, - "features" : { - "type" : "array", - "deprecated" : false, - "items" : { - "type" : "object", - "deprecated" : false, - "properties" : { - "id" : { - "type" : "string", - "deprecated" : false, - "maxLength" : 50, - "example" : null - }, - "name" : { - "type" : "string", - "deprecated" : false, - "maxLength" : 50, - "example" : null - }, - "description" : { - "type" : "string", - "deprecated" : false, - "maxLength" : 500, - "example" : null - }, - "status" : { - "type" : "string", - "deprecated" : false, - "enum" : [ "active", "archived", "draft" ], - "example" : null - }, - "type" : { - "type" : "string", - "deprecated" : false, - "enum" : [ "switch", "custom", "quantity", "range" ], - "example" : null - }, - "unit" : { - "type" : "string", - "deprecated" : false, - "maxLength" : 50, - "example" : null - }, - "resource_version" : { - "type" : "integer", - "format" : "int64", - "deprecated" : false, - "example" : null - }, - "updated_at" : { - "type" : "integer", - "format" : "unix-time", - "deprecated" : false, - "example" : null - }, - "created_at" : { - "type" : "integer", - "format" : "unix-time", - "deprecated" : false, - "example" : null - }, - "levels" : { - "type" : "array", - "deprecated" : false, - "items" : { - "type" : "object", - "deprecated" : false, - "properties" : { - "name" : { - "type" : "string", - "deprecated" : false, - "maxLength" : 50, - "example" : null - }, - "value" : { - "type" : "string", - "deprecated" : false, - "maxLength" : 50, - "example" : null - }, - "level" : { - "type" : "integer", - "format" : "int32", - "deprecated" : false, - "example" : null - }, - "is_unlimited" : { - "type" : "boolean", - "deprecated" : false, - "example" : null - } - }, - "required" : [ "is_unlimited", "level", "value" ], - "example" : null - }, - "example" : null - } - }, - "required" : [ "created_at", "id", "name" ], - "example" : null - }, - "example" : null - } - }, - "required" : [ "feature_id", "id", "name", "query", "type" ], - "example" : null - }, - "MeteredFeature" : { - "type" : "object", - "properties" : { - "meter_id" : { - "type" : "string", - "deprecated" : false, - "maxLength" : 50, - "example" : null - }, - "feature_id" : { - "type" : "string", - "deprecated" : false, - "maxLength" : 50, - "example" : null - }, - "id" : { - "type" : "string", - "deprecated" : false, - "maxLength" : 50, - "example" : null - }, - "column_definitions" : { - "type" : "array", - "deprecated" : false, - "items" : { - "type" : "object", - "deprecated" : false, - "properties" : { - "column_name" : { - "type" : "string", - "deprecated" : false, - "maxLength" : 100, - "example" : null - }, - "property_data_type" : { - "type" : "string", - "deprecated" : false, - "enum" : [ "number", "string" ], - "example" : null - }, - "data_type" : { - "type" : "string", - "deprecated" : false, - "enum" : [ "number", "string" ], - "example" : null - } - }, - "required" : [ "column_name", "data_type", "property_data_type" ], - "example" : null - }, - "example" : null - } - }, - "required" : [ "feature_id", "id", "meter_id" ], + "MeterType" : { + "type" : "string", + "deprecated" : true, + "enum" : [ "simple", "compound" ], "example" : null }, "Mode" : { @@ -146065,7 +146278,7 @@ "default" : "card", "deprecated" : false, "description" : "The payment method of this intent\n\\* alipay_hk - \\* apple_pay -\n\napple_pay\n\\* netbanking_emandates -\n\nnetbanking_emandates\n\\* venmo -\n\nVenmo\n\\* after_pay -\n\nPayments made via Afterpay\n\\* giropay -\n\ngiropay\n\\* paypal_express_checkout -\n\npaypal_express_checkout\n\\* pix -\n\nPix\n\\* amazon_payments -\n\namazon_payments\n\\* grab_pay -\n\nPayments made via GrabPay\n\\* card -\n\ncard\n\\* go_pay -\n\nPayments made via GoPay\n\\* google_pay -\n\ngoogle_pay\n\\* cash_app_pay -\n\nPayments made via Cash App Pay.\n\\* ideal -\n\nideal\n\\* dotpay -\n\ndotpay\n\\* sofort -\n\nsofort\n\\* gcash - \\* faster_payments -\n\nFaster Payments\n\\* online_banking_poland - \\* klarna -\n\nPayments made via Klarna.\n\\* swish -\n\nPayments made via Swish\n\\* kbc_payment_button -\n\nKBC Payment Button\n\\* bancontact -\n\nbancontact\n\\* trustly -\n\nTrustly\n\\* paypay - \\* kakao_pay -\n\nPayments made via Kakao Pay.\n\\* boleto -\n\nboleto\n\\* revolut_pay -\n\nPayments made via Revolut Pay.\n\\* naver_pay -\n\nPayments made via Naver Pay.\n\\* electronic_payment_standard -\n\nElectronic Payment Standard\n\\* pay_by_bank -\n\nPay By Bank\n\\* payme -\n\nPayments made via PayMe\n\\* pay_co -\n\nPayments made via PayCo\n\\* pay_to -\n\nPayTo\n\\* alipay -\n\nPayments made via Alipay.\n\\* sepa_instant_transfer -\n\nSEPA Instant Transfer\n\\* direct_debit -\n\ndirect_debit\n\\* klarna_pay_now -\n\nKlarna Pay Now\n\\* stablecoin -\n\nPayments made via Stablecoin.\n\\* upi -\n\nupi\n\\* south_korean_cards - \\* payconiq_by_bancontact -\n\nPayments made via Payconiq by Bancontact.\n\\* twint -\n\nPayments made via Twint\n\\* wechat_pay -\n\nPayments made via WeChat Pay.\n", - "enum" : [ "card", "ideal", "sofort", "bancontact", "google_pay", "dotpay", "giropay", "apple_pay", "upi", "netbanking_emandates", "paypal_express_checkout", "direct_debit", "boleto", "venmo", "amazon_payments", "pay_to", "faster_payments", "sepa_instant_transfer", "klarna_pay_now", "online_banking_poland", "payconiq_by_bancontact", "electronic_payment_standard", "kbc_payment_button", "pay_by_bank", "trustly", "stablecoin", "kakao_pay", "naver_pay", "revolut_pay", "cash_app_pay", "wechat_pay", "alipay", "twint", "go_pay", "grab_pay", "pay_co", "after_pay", "swish", "payme", "pix", "klarna", "alipay_hk", "paypay", "gcash", "south_korean_cards" ], + "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" ], "example" : null }, "success_url" : { @@ -146154,7 +146367,7 @@ "default" : "card", "deprecated" : false, "description" : "The payment method of this attempt\n\\* stablecoin - \\* venmo -\n\nVenmo\n\\* sofort -\n\nsofort\n\\* paypal_express_checkout -\n\npaypal_express_checkout\n\\* alipay - \\* giropay -\n\ngiropay\n\\* bancontact -\n\nbancontact\n\\* naver_pay - \\* go_pay - \\* kakao_pay - \\* card -\n\ncard\n\\* faster_payments -\n\nFaster Payments\n\\* paypay - \\* south_korean_cards - \\* kbc_payment_button -\n\nKBC Payment Button\n\\* ideal -\n\nideal\n\\* sepa_instant_transfer -\n\nSEPA Instant Transfer\n\\* gcash - \\* pay_by_bank -\n\nPay By Bank\n\\* klarna -\n\nPayments made via Klarna.\n\\* online_banking_poland - \\* swish - \\* electronic_payment_standard -\n\nElectronic Payment Standard\n\\* boleto -\n\nboleto\n\\* wechat_pay - \\* cash_app_pay - \\* revolut_pay - \\* grab_pay - \\* trustly -\n\nTrustly\n\\* payme - \\* alipay_hk - \\* upi -\n\nupi\n\\* amazon_payments -\n\namazon_payments\n\\* direct_debit -\n\ndirect_debit\n\\* after_pay - \\* dotpay -\n\ndotpay\n\\* apple_pay -\n\napple_pay\n\\* netbanking_emandates -\n\nnetbanking_emandates\n\\* klarna_pay_now -\n\nKlarna Pay Now\n\\* google_pay -\n\ngoogle_pay\n\\* payconiq_by_bancontact - \\* pay_co - \\* twint - \\* pay_to -\n\nPayTo\n\\* pix -\n", - "enum" : [ "card", "ideal", "sofort", "bancontact", "google_pay", "dotpay", "giropay", "apple_pay", "upi", "netbanking_emandates", "paypal_express_checkout", "direct_debit", "boleto", "venmo", "amazon_payments", "pay_to", "faster_payments", "sepa_instant_transfer", "klarna_pay_now", "online_banking_poland", "payconiq_by_bancontact", "electronic_payment_standard", "kbc_payment_button", "pay_by_bank", "trustly", "stablecoin", "kakao_pay", "naver_pay", "revolut_pay", "cash_app_pay", "wechat_pay", "alipay", "twint", "go_pay", "grab_pay", "pay_co", "after_pay", "swish", "payme", "pix", "klarna", "alipay_hk", "paypay", "gcash", "south_korean_cards" ], + "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" ], "example" : null }, "id_at_gateway" : { @@ -146343,7 +146556,7 @@ "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" ], + "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" ], "example" : null }, "id_at_gateway" : { @@ -146506,6 +146719,39 @@ "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" ], @@ -146621,7 +146867,7 @@ "type" : "string", "default" : "card", "deprecated" : false, - "enum" : [ "cash", "check", "bank_transfer", "other", "custom", "chargeback", "card", "amazon_payments", "paypal_express_checkout", "direct_debit", "alipay", "unionpay", "apple_pay", "wechat_pay", "ach_credit", "sepa_credit", "ideal", "google_pay", "sofort", "bancontact", "giropay", "dotpay", "upi", "netbanking_emandates", "boleto", "venmo", "pay_to", "faster_payments", "sepa_instant_transfer", "automated_bank_transfer", "klarna_pay_now", "online_banking_poland", "payconiq_by_bancontact", "electronic_payment_standard", "kbc_payment_button", "pay_by_bank", "trustly", "stablecoin", "kakao_pay", "naver_pay", "revolut_pay", "cash_app_pay", "pix", "twint", "go_pay", "grab_pay", "pay_co", "after_pay", "swish", "payme", "klarna", "alipay_hk", "paypay", "gcash", "south_korean_cards" ], + "enum" : [ "cash", "check", "bank_transfer", "other", "custom", "chargeback", "card", "amazon_payments", "paypal_express_checkout", "direct_debit", "alipay", "unionpay", "apple_pay", "wechat_pay", "ach_credit", "sepa_credit", "ideal", "google_pay", "sofort", "bancontact", "giropay", "dotpay", "upi", "netbanking_emandates", "boleto", "venmo", "pay_to", "faster_payments", "sepa_instant_transfer", "automated_bank_transfer", "klarna_pay_now", "online_banking_poland", "payconiq_by_bancontact", "electronic_payment_standard", "kbc_payment_button", "pay_by_bank", "trustly", "stablecoin", "kakao_pay", "naver_pay", "revolut_pay", "cash_app_pay", "pix", "twint", "go_pay", "grab_pay", "pay_co", "after_pay", "swish", "payme", "klarna", "alipay_hk", "paypay", "gcash", "south_korean_cards", "paynow", "bizum", "promptpay" ], "example" : null }, "PaymentMethodSavePolicy" : { @@ -146633,7 +146879,7 @@ "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" ], + "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" ], "example" : null }, "PaymentReferenceNumber" : { @@ -146980,7 +147226,7 @@ "type" : "string", "deprecated" : false, "description" : "Type of payment source\n\\* direct_debit -\n\nRepresents bank account for which the direct debit or ACH agreement/mandate is created.\n\\* unionpay -\n\nPayments made via UnionPay.\n\\* sepa_instant_transfer -\n\nPayments made via Sepa Instant Transfer\n\\* dotpay -\n\nPayments made via Dotpay.\n\\* klarna -\n\nPayments made via Klarna.\n\\* giropay -\n\nPayments made via giropay.\n\\* grab_pay -\n\nPayments made via GrabPay\n\\* stablecoin -\n\nPayments made via Stablecoin.\n\\* bancontact -\n\nPayments made via Bancontact Card.\n\\* amazon_payments -\n\nPayments made via Amazon Payments.\n\\* pay_by_bank -\n\nPay By Bank\n\\* online_banking_poland -\n\nPayments made via Online Banking Poland\n\\* after_pay -\n\nPayments made via Afterpay\n\\* paypay - \\* generic -\n\nPayments made via Generic Payment Method.\n\\* twint -\n\nPayments made via Twint\n\\* automated_bank_transfer -\n\nRepresents virtual bank account using which the payment will be done.\n\\* paypal_express_checkout -\n\nPayments made via PayPal Express Checkout.\n\\* trustly -\n\nTrustly\n\\* upi -\n\nUPI Payments.\n\\* cash_app_pay -\n\nPayments made via Cash App Pay.\n\\* south_korean_cards - \\* electronic_payment_standard -\n\nElectronic Payment Standard\n\\* google_pay -\n\nPayments made via Google Pay.\n\\* pay_to -\n\nPayments made via PayTo\n\\* revolut_pay -\n\nPayments made via Revolut Pay.\n\\* naver_pay -\n\nPayments made via Naver Pay.\n\\* alipay -\n\nPayments made via Alipay. \nThis payment source is deprecated.\n\\* kakao_pay -\n\nPayments made via Kakao Pay.\n\\* sofort -\n\nPayments made via Sofort.\n\\* pix -\n\nPayments made via Pix\n\\* 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\\* go_pay -\n\nPayments made via GoPay\n\\* card -\n\nCard based payment including credit cards and debit cards. Details about the card can be obtained from the card resource.\n\\* faster_payments -\n\nPayments made via Faster Payments\n\\* alipay_hk - \\* payme -\n\nPayments made via PayMe\n\\* klarna_pay_now -\n\nPayments made via Klarna Pay Now\n\\* swish -\n\nPayments made via Swish\n\\* venmo -\n\nPayments made via Venmo\n\\* ideal -\n\nPayments made via iDEAL.\n\\* kbc_payment_button -\n\nKBC Payment Button\n\\* payconiq_by_bancontact -\n\nPayments made via Payconiq by Bancontact.\n\\* apple_pay -\n\nPayments made via Apple Pay.\n", - "enum" : [ "card", "paypal_express_checkout", "amazon_payments", "direct_debit", "generic", "alipay", "unionpay", "apple_pay", "wechat_pay", "ideal", "google_pay", "sofort", "bancontact", "giropay", "dotpay", "upi", "netbanking_emandates", "venmo", "pay_to", "faster_payments", "sepa_instant_transfer", "automated_bank_transfer", "klarna_pay_now", "online_banking_poland", "payconiq_by_bancontact", "electronic_payment_standard", "kbc_payment_button", "pay_by_bank", "trustly", "stablecoin", "kakao_pay", "naver_pay", "revolut_pay", "cash_app_pay", "twint", "go_pay", "grab_pay", "pay_co", "after_pay", "swish", "payme", "pix", "klarna", "alipay_hk", "paypay", "gcash", "south_korean_cards" ], + "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" ], "example" : null }, "reference_id" : { @@ -149149,7 +149395,7 @@ "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.

", + "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.

", "minimum" : 0, "example" : null }, @@ -150416,6 +150662,13 @@ "description" : "A unique identifier for the customer this line item belongs to\n", "maxLength" : 100, "example" : null + }, + "proration_mode" : { + "type" : "string", + "deprecated" : false, + "description" : "null\n", + "enum" : [ "reset", "delta", "service_period_revision", "adjusted_term" ], + "example" : null } }, "required" : [ "date_from", "date_to", "description", "entity_type", "is_taxed", "unit_amount" ], @@ -151445,6 +151698,13 @@ "description" : "A unique identifier for the customer this line item belongs to\n", "maxLength" : 100, "example" : null + }, + "proration_mode" : { + "type" : "string", + "deprecated" : false, + "description" : "null\n", + "enum" : [ "reset", "delta", "service_period_revision", "adjusted_term" ], + "example" : null } }, "required" : [ "date_from", "date_to", "description", "entity_type", "is_taxed", "unit_amount" ], @@ -151813,6 +152073,12 @@ "maxLength" : 250, "example" : null }, + "entity_description" : { + "type" : "string", + "deprecated" : false, + "maxLength" : 500, + "example" : null + }, "service_period_in_days" : { "type" : "integer", "format" : "int32", @@ -153271,18 +153537,37 @@ "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.

", "properties" : { + "site_owner_id" : { + "type" : "string", + "deprecated" : false, + "maxLength" : 50, + "example" : null + }, "id" : { "type" : "string", "deprecated" : false, "description" : "Unique identifier of the platform site. Maximum length is 40 characters.\n", - "maxLength" : 40, + "maxLength" : 60, "example" : null }, - "site_id" : { + "currency_code" : { "type" : "string", "deprecated" : false, - "description" : "Unique identifier of the Chargebee site associated with this platform site.\n", - "maxLength" : 60, + "maxLength" : 3, + "example" : null + }, + "status" : { + "type" : "string", + "deprecated" : false, + "description" : "null\n", + "enum" : [ "active", "disabled", "cancelled" ], + "example" : null + }, + "type" : { + "type" : "string", + "deprecated" : false, + "description" : "null\n", + "enum" : [ "sandbox", "live" ], "example" : null }, "domain" : { @@ -153290,13 +153575,15 @@ "deprecated" : false, "description" : "Domain name of the platform site. Maximum length is 50 characters.\n", "maxLength" : 50, + "minLength" : 4, "example" : null }, - "site_type" : { + "locale" : { "type" : "string", + "default" : "en", "deprecated" : false, - "description" : "

Type of the platform site. Possible values are:

\n", - "enum" : [ "sandbox", "live", "both" ], + "description" : "null\n", + "enum" : [ "en", "fr", "de", "it", "pt", "es", "da", "tr", "fi", "sl", "zh", "sv", "ja", "ru", "nl", "lt", "lv", "et", "pl", "id", "cs", "sk", "ko", "no", "ro", "th", "vi", "bg", "hu", "uk", "hr" ], "example" : null }, "created_at" : { @@ -153305,9 +153592,68 @@ "deprecated" : false, "description" : "Timestamp indicating when this platform site was created.\n", "example" : null + }, + "timezone" : { + "type" : "string", + "default" : "UTC", + "deprecated" : false, + "maxLength" : 50, + "example" : null + }, + "created_from_ip" : { + "type" : "string", + "deprecated" : false, + "maxLength" : 50, + "example" : null + }, + "linked_sites" : { + "type" : "array", + "deprecated" : false, + "items" : { + "type" : "object", + "deprecated" : false, + "properties" : { + "id" : { + "type" : "string", + "deprecated" : false, + "maxLength" : 60, + "example" : null + }, + "domain" : { + "type" : "string", + "deprecated" : false, + "maxLength" : 50, + "minLength" : 4, + "example" : null + }, + "type" : { + "type" : "string", + "deprecated" : false, + "description" : "null\n", + "enum" : [ "sandbox", "live" ], + "example" : null + }, + "status" : { + "type" : "string", + "deprecated" : false, + "description" : "null\n", + "enum" : [ "active", "disabled", "cancelled" ], + "example" : null + }, + "created_at" : { + "type" : "integer", + "format" : "unix-time", + "deprecated" : false, + "example" : null + } + }, + "required" : [ "created_at", "domain" ], + "example" : null + }, + "example" : null } }, - "required" : [ "created_at", "id", "site_id" ], + "required" : [ "created_at", "domain" ], "example" : null }, "SiteMigrationDetail" : { @@ -153394,6 +153740,12 @@ "maxLength" : 50, "example" : null }, + "created_at" : { + "type" : "integer", + "format" : "unix-time", + "deprecated" : false, + "example" : null + }, "updated_at" : { "type" : "integer", "format" : "unix-time", @@ -153402,7 +153754,7 @@ "example" : null } }, - "required" : [ "email", "id" ], + "required" : [ "created_at", "email", "id" ], "example" : null }, "SitePcMetaRecord" : { @@ -153444,9 +153796,8 @@ }, "Status" : { "type" : "string", - "default" : "available", "deprecated" : false, - "enum" : [ "available", "exhausted", "scheduled", "in_grace_period" ], + "enum" : [ "active", "archived", "deleted", "available", "exhausted", "scheduled", "in_grace_period" ], "example" : null }, "Subscription" : { @@ -153895,7 +154246,7 @@ "auto_close_invoices" : { "type" : "boolean", "deprecated" : false, - "description" : "

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.

", + "description" : "

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.

", "example" : null }, "business_entity_id" : { @@ -153940,7 +154291,7 @@ "type" : "integer", "format" : "int64", "deprecated" : false, - "description" : "

The price or per-unit-price of the addon. The value depends on the type of currency.

\n

Note:

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:

", + "description" : "

The price or per-unit-price of the addon. The value depends on the type of currency.

\n

Note:

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:

", "minimum" : 0, "example" : null }, @@ -157146,7 +157497,7 @@ "TaxOverrideReason" : { "type" : "string", "deprecated" : false, - "enum" : [ "id_exempt", "customer_exempt", "export" ], + "enum" : [ "zero_rated", "id_exempt", "customer_exempt", "region_non_taxable", "product_exempt", "export", "high_value_physical_goods", "zero_value_item", "tax_not_configured_external_provider" ], "example" : null }, "TaxWithheld" : { @@ -157404,7 +157755,7 @@ "default" : "card", "deprecated" : false, "description" : "Type of the payment method.\n\\* direct_debit -\n\nRepresents bank account for which the direct debit or ACH agreement/mandate is created.\n\\* unionpay -\n\nPayments made via UnionPay.\n\\* google_pay -\n\nPayments made via Google Pay.\n\\* sepa_instant_transfer -\n\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\\* pay_co -\n\nPayments made via PayCo\n\\* wechat_pay -\n\nPayments made via WeChat Pay. \nThis payment source is deprecated.\n\\* netbanking_emandates -\n\nNetbanking (eMandates) Payments.\n\\* bancontact -\n\nPayments made via Bancontact Card.\n\\* go_pay -\n\nPayments made via GoPay\n\\* card -\n\nCard based payment including credit cards and debit cards. Details about the card can be obtained from the card resource.\n\\* amazon_payments -\n\nPayments made via Amazon Payments.\n\\* pay_by_bank -\n\nPay By Bank\n\\* online_banking_poland -\n\nPayments made via Online Banking Poland\n\\* after_pay -\n\nPayments made via Afterpay\n\\* faster_payments -\n\nPayments made via Faster Payments\n\\* generic -\n\nPayments made via Generic Payment Method.\n\\* payme -\n\nPayments made via PayMe\n\\* klarna_pay_now -\n\nPayments made via Klarna Pay Now\n\\* twint -\n\nPayments made via Twint\n\\* swish -\n\nPayments made via Swish\n\\* automated_bank_transfer -\n\nRepresents virtual bank account using which the payment will be done.\n\\* paypal_express_checkout -\n\nPayments made via PayPal Express Checkout.\n\\* venmo -\n\nPayments made via Venmo\n\\* ideal -\n\nPayments made via iDEAL.\n\\* trustly -\n\nTrustly\n\\* upi -\n\nUPI Payments.\n\\* kbc_payment_button -\n\nKBC Payment Button\n\\* cash_app_pay -\n\nPayments made via Cash App Pay.\n\\* payconiq_by_bancontact -\n\nPayments made via Payconiq by Bancontact.\n\\* apple_pay -\n\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" ], + "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" ], "example" : null }, "gateway" : { @@ -157929,7 +158280,7 @@ "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\\* bancontact -\n\nPayments made via Bancontact Card.\n\\* netbanking_emandates -\n\nNetbanking (eMandates) Payments.\n\\* trustly -\n\nTrustly\n\\* after_pay -\n\nPayments made via Afterpay\n\\* alipay -\n\nPayments made via Alipay. \nThis payment source is deprecated.\n\\* dotpay -\n\nPayments made via Dotpay.\n\\* giropay -\n\nPayments made via giropay.\n\\* sofort -\n\nPayments made via Sofort.\n\\* direct_debit -\n\nRepresents bank account for which the direct debit or ACH agreement/mandate is created.\n\\* paypal_express_checkout -\n\nPayments made via PayPal Express Checkout.\n\\* amazon_payments -\n\nPayments made via Amazon Payments.\n\\* electronic_payment_standard -\n\nElectronic Payment Standard\n\\* grab_pay -\n\nPayments made via GrabPay\n\\* card -\n\nCard based payment including credit cards and debit cards. Details about the card can be obtained from the card resource.\n\\* upi -\n\nUPI Payments.\n\\* pay_by_bank -\n\nPay By Bank\n\\* go_pay -\n\nPayments made via GoPay\n\\* swish -\n\nPayments made via Swish\n\\* twint -\n\nPayments made via Twint\n\\* generic -\n\nPayments made via Generic Payment Method.\n\\* payme -\n\nPayments made via PayMe\n\\* wechat_pay -\n\nPayments made via WeChat Pay. \nThis payment source is deprecated.\n\\* kbc_payment_button -\n\nKBC Payment Button\n", - "enum" : [ "card", "paypal_express_checkout", "amazon_payments", "direct_debit", "generic", "alipay", "unionpay", "apple_pay", "wechat_pay", "ideal", "google_pay", "sofort", "bancontact", "giropay", "dotpay", "upi", "netbanking_emandates", "venmo", "pay_to", "faster_payments", "sepa_instant_transfer", "automated_bank_transfer", "klarna_pay_now", "online_banking_poland", "payconiq_by_bancontact", "electronic_payment_standard", "kbc_payment_button", "pay_by_bank", "trustly", "stablecoin", "kakao_pay", "naver_pay", "revolut_pay", "cash_app_pay", "twint", "go_pay", "grab_pay", "pay_co", "after_pay", "swish", "payme", "pix", "klarna", "alipay_hk", "paypay", "gcash", "south_korean_cards" ], + "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" ], "example" : null }, "status" : { @@ -158196,7 +158547,7 @@ "default" : "card", "deprecated" : false, "description" : "

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.

\n* automated_bank_transfer -

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" ], + "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" ], "example" : null }, "reference_number" : { @@ -158957,7 +159308,7 @@ "Type" : { "type" : "string", "deprecated" : false, - "enum" : [ "card", "paypal_express_checkout", "amazon_payments", "direct_debit", "generic", "alipay", "unionpay", "apple_pay", "wechat_pay", "ideal", "google_pay", "sofort", "bancontact", "giropay", "dotpay", "upi", "netbanking_emandates", "venmo", "pay_to", "faster_payments", "sepa_instant_transfer", "automated_bank_transfer", "klarna_pay_now", "online_banking_poland", "payconiq_by_bancontact", "electronic_payment_standard", "kbc_payment_button", "pay_by_bank", "trustly", "stablecoin", "kakao_pay", "naver_pay", "revolut_pay", "cash_app_pay", "twint", "go_pay", "grab_pay", "pay_co", "after_pay", "swish", "payme", "pix", "klarna", "alipay_hk", "paypay", "gcash", "south_korean_cards", "free_trial", "pay_up_front", "pay_as_you_go", "usage_exceeded" ], + "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", "free_trial", "pay_up_front", "pay_as_you_go", "simple", "compound", "usage_exceeded", "spend_exceeded" ], "example" : null }, "UnbilledCharge" : { @@ -160156,6 +160507,16 @@ "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", @@ -160514,8 +160875,8 @@ "type" : "string" } }, - "invoice-id" : { - "name" : "invoice-id", + "site-id" : { + "name" : "site-id", "in" : "path", "required" : true, "style" : "simple", @@ -160524,8 +160885,8 @@ "type" : "string" } }, - "feature-id" : { - "name" : "feature-id", + "invoice-id" : { + "name" : "invoice-id", "in" : "path", "required" : true, "style" : "simple", @@ -160534,8 +160895,8 @@ "type" : "string" } }, - "transaction-id" : { - "name" : "transaction-id", + "feature-id" : { + "name" : "feature-id", "in" : "path", "required" : true, "style" : "simple", @@ -160544,8 +160905,8 @@ "type" : "string" } }, - "platform-site-id" : { - "name" : "platform-site-id", + "transaction-id" : { + "name" : "transaction-id", "in" : "path", "required" : true, "style" : "simple", diff --git a/spec/chargebee_api_v2_pc_v1_spec.yaml b/spec/chargebee_api_v2_pc_v1_spec.yaml index 7dcdd260..e28574e3 100644 --- a/spec/chargebee_api_v2_pc_v1_spec.yaml +++ b/spec/chargebee_api_v2_pc_v1_spec.yaml @@ -5,10 +5,10 @@ info: name: Chargebee Support url: https://www.chargebee.com email: support@chargebee.com - version: 2026-06-12.a49b34edd262e3e190bd6d8616ff9e401c37bd21 + version: 2026-07-21.2a6a65b3e1a8ff29840466a7bfdb5cdd778d0634 x-cb-api-version: 2 x-cb-product-catalog-version: 1 - x-generated-on: 1781239687838 + x-generated-on: 1784611165580 servers: - url: "{protocol}://{site}.{environment}:{port}/api/v2" variables: @@ -956,6 +956,9 @@ paths: - paypay - gcash - south_korean_cards + - paynow + - bizum + - promptpay example: null reference_id: type: string @@ -2253,7 +2256,7 @@ paths: description: |-

optional, boolean filter

Set to false - to override for this subscription, the site-level setting + to override for this subscription, the site-level setting for auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute has a higher precedence than the same attribute at the customer level. Possible values are : true, false

Supported operators : @@ -2457,6 +2460,24 @@ paths: 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 @@ -4009,6 +4030,9 @@ paths: - paypay - gcash - south_korean_cards + - paynow + - bizum + - promptpay example: null gateway_account_id: type: string @@ -4335,6 +4359,9 @@ paths: - paypay - gcash - south_korean_cards + - paynow + - bizum + - promptpay example: null reference_id: type: string @@ -7386,6 +7413,9 @@ paths: - paypay - gcash - south_korean_cards + - paynow + - bizum + - promptpay example: null reference_id: type: string @@ -9029,6 +9059,9 @@ paths: - paypay - gcash - south_korean_cards + - paynow + - bizum + - promptpay example: null reference_id: type: string @@ -11711,6 +11744,9 @@ paths: - paypay - gcash - south_korean_cards + - paynow + - bizum + - promptpay example: null gateway_account_id: type: string @@ -12513,7 +12549,7 @@ paths: - BasicAuth: [] /subscriptions/{subscription-id}/import_unbilled_charges: post: - summary: Import Unbilled Charges + summary: Import unbilled charges description: | Imports unbilled charges into Chargebee. operationId: import_unbilled_charges @@ -14530,6 +14566,9 @@ paths: - paypay - gcash - south_korean_cards + - paynow + - bizum + - promptpay example: null gateway_account_id: type: string @@ -14844,6 +14883,9 @@ paths: - paypay - gcash - south_korean_cards + - paynow + - bizum + - promptpay example: null reference_id: type: string @@ -16143,7 +16185,7 @@ paths: - BasicAuth: [] /subscriptions/{subscription-id}/override_billing_profile: post: - summary: Override Billing Profile + 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\ @@ -17360,7 +17402,7 @@ paths: - BasicAuth: [] /subscriptions/{subscription-id}/edit_advance_invoice_schedule: post: - summary: Edit Advance Invoice Schedule + summary: Edit advance invoice schedule description: | Modifies the [advance invoicing schedule](/docs/api/advance_invoice_schedules) for a subscription. operationId: edit_advance_invoice_schedule @@ -20649,6 +20691,9 @@ paths: - paypay - gcash - south_korean_cards + - paynow + - bizum + - promptpay example: null gateway_account_id: type: string @@ -21484,7 +21529,7 @@ paths: type: boolean deprecated: false description: | - Override for this customer, the [site-level setting](https://www.chargebee.com/docs/2.0/metered_billing.html#configuring-metered-billing) + Override for this customer, the [site-level setting](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing) for auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute is also available at the [subscription level](/docs/api/subscriptions/subscription-object#auto_close_invoices) which takes precedence. example: null @@ -22846,7 +22891,7 @@ paths: description: | optional, boolean filter - Override for this customer, the [site-level setting](https://www.chargebee.com/docs/2.0/metered_billing.html#configuring-metered-billing) + Override for this customer, the [site-level setting](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing) for auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute is also available at the [subscription level](/docs/api/subscriptions/subscription-object#auto_close_invoices) which takes precedence. Possible values are : *true, false* @@ -23767,7 +23812,7 @@ paths: type: boolean deprecated: false description: | - Override for this customer, the [site-level setting](https://www.chargebee.com/docs/2.0/metered_billing.html#configuring-metered-billing) + Override for this customer, the [site-level setting](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing) for auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute is also available at the [subscription level](/docs/api/subscriptions/subscription-object#auto_close_invoices) which takes precedence. example: null @@ -24300,6 +24345,9 @@ paths: - paypay - gcash - south_korean_cards + - paynow + - bizum + - promptpay example: null gateway_account_id: type: string @@ -24626,6 +24674,9 @@ paths: - paypay - gcash - south_korean_cards + - paynow + - bizum + - promptpay example: null reference_id: type: string @@ -25564,7 +25615,7 @@ paths: - BasicAuth: [] /customers/{customer-id}/clear_personal_data: post: - summary: Clear Personal Data of a customer + summary: Clear personal data of a customer description: | Clear personal details of a customer using this API. operationId: clear_personal_data_of_a_customer @@ -26293,6 +26344,9 @@ paths: - paypay - gcash - south_korean_cards + - paynow + - bizum + - promptpay example: null gateway_account_id: type: string @@ -26817,6 +26871,9 @@ paths: - paypay - gcash - south_korean_cards + - paynow + - bizum + - promptpay example: null reference_id: type: string @@ -28848,6 +28905,9 @@ paths: - paypay - gcash - south_korean_cards + - paynow + - bizum + - promptpay example: null id_at_vault: type: string @@ -28952,6 +29012,11 @@ paths: example: null + browser_details: + type: object + additionalProperties: true + deprecated: false + example: null token_additional_detail: type: object deprecated: false @@ -29273,6 +29338,11 @@ paths: schema: type: object properties: + browser_details: + type: object + additionalProperties: true + deprecated: false + example: null card: type: object deprecated: false @@ -30043,6 +30113,9 @@ paths: - paypay - gcash - south_korean_cards + - paynow + - bizum + - promptpay example: null gateway_account_id: type: string @@ -31686,7 +31759,7 @@ paths: is: type: string description: | - \* \`card\` - Card based payment including credit cards and debit cards. Details about the card can be obtained from the card resource. \* \`paypal_express_checkout\` - Payments made via PayPal Express Checkout. \* \`amazon_payments\` - Payments made via Amazon Payments. \* \`direct_debit\` - Represents bank account for which the direct debit or ACH agreement/mandate is created. \* \`generic\` - Payments made via Generic Payment Method. \* \`alipay\` - Payments made via Alipay \* \`unionpay\` - Payments made via UnionPay. \* \`apple_pay\` - Payments made via Apple Pay. \* \`wechat_pay\` - Payments made via WeChat Pay \* \`ideal\` - Payments made via iDEAL. \* \`google_pay\` - Payments made via Google Pay. \* \`sofort\` - Payments made via Sofort. \* \`bancontact\` - Payments made via Bancontact Card. \* \`giropay\` - Payments made via giropay. \* \`dotpay\` - Payments made via Dotpay. \* \`upi\` - UPI Payments. \* \`netbanking_emandates\` - Netbanking (eMandates) Payments. \* \`venmo\` - Payments made via Venmo \* \`pay_to\` - Payments made via PayTo \* \`faster_payments\` - Payments made via Faster Payments \* \`sepa_instant_transfer\` - Payments made via Sepa Instant Transfer \* \`automated_bank_transfer\` - Represents virtual bank account using which the payment will be done. \* \`klarna_pay_now\` - Payments made via Klarna Pay Now \* \`online_banking_poland\` - Payments made via Online Banking Poland \* \`payconiq_by_bancontact\` - Payments made via Payconiq by Bancontact \* \`electronic_payment_standard\` - Payments made via Electronic Payment Standard. \* \`kbc_payment_button\` - Payments made via KBC Payment Button. \* \`pay_by_bank\` - Payments made via Pay By Bank. \* \`trustly\` - Payments made via Trustly. \* \`stablecoin\` - Payments made via Stablecoin \* \`kakao_pay\` - Payments made via Kakao Pay \* \`naver_pay\` - Payments made via Naver Pay \* \`revolut_pay\` - Payments made via Revolut Pay \* \`cash_app_pay\` - Payments made via Cash App Pay \* \`twint\` - Payments made via Twint \* \`go_pay\` - Payments made via Go Pay \* \`grab_pay\` - Payments made via Grab Pay \* \`pay_co\` - Payments made via Pay Co \* \`after_pay\` - Payments made via After pay \* \`swish\` - Payments made via Swish \* \`payme\` - Payments made via PayMe \* \`pix\` - Payments made via Pix \* \`klarna\` - Payments made via Klarna \* \`alipay_hk\` - Payments made via Alipay HK \* \`paypay\` - Payments made via PayPay \* \`gcash\` - Payments made via GCash \* \`south_korean_cards\` - Payments made via South Korean Cards + \* \`card\` - Card based payment including credit cards and debit cards. Details about the card can be obtained from the card resource. \* \`paypal_express_checkout\` - Payments made via PayPal Express Checkout. \* \`amazon_payments\` - Payments made via Amazon Payments. \* \`direct_debit\` - Represents bank account for which the direct debit or ACH agreement/mandate is created. \* \`generic\` - Payments made via Generic Payment Method. \* \`alipay\` - Payments made via Alipay \* \`unionpay\` - Payments made via UnionPay. \* \`apple_pay\` - Payments made via Apple Pay. \* \`wechat_pay\` - Payments made via WeChat Pay \* \`ideal\` - Payments made via iDEAL. \* \`google_pay\` - Payments made via Google Pay. \* \`sofort\` - Payments made via Sofort. \* \`bancontact\` - Payments made via Bancontact Card. \* \`giropay\` - Payments made via giropay. \* \`dotpay\` - Payments made via Dotpay. \* \`upi\` - UPI Payments. \* \`netbanking_emandates\` - Netbanking (eMandates) Payments. \* \`venmo\` - Payments made via Venmo \* \`pay_to\` - Payments made via PayTo \* \`faster_payments\` - Payments made via Faster Payments \* \`sepa_instant_transfer\` - Payments made via Sepa Instant Transfer \* \`automated_bank_transfer\` - Represents virtual bank account using which the payment will be done. \* \`klarna_pay_now\` - Payments made via Klarna Pay Now \* \`online_banking_poland\` - Payments made via Online Banking Poland \* \`payconiq_by_bancontact\` - Payments made via Payconiq by Bancontact \* \`electronic_payment_standard\` - Payments made via Electronic Payment Standard. \* \`kbc_payment_button\` - Payments made via KBC Payment Button. \* \`pay_by_bank\` - Payments made via Pay By Bank. \* \`trustly\` - Payments made via Trustly. \* \`stablecoin\` - Payments made via Stablecoin \* \`kakao_pay\` - Payments made via Kakao Pay \* \`naver_pay\` - Payments made via Naver Pay \* \`revolut_pay\` - Payments made via Revolut Pay \* \`cash_app_pay\` - Payments made via Cash App Pay \* \`twint\` - Payments made via Twint \* \`go_pay\` - Payments made via Go Pay \* \`grab_pay\` - Payments made via Grab Pay \* \`pay_co\` - Payments made via Pay Co \* \`after_pay\` - Payments made via After pay \* \`swish\` - Payments made via Swish \* \`payme\` - Payments made via PayMe \* \`pix\` - Payments made via Pix \* \`klarna\` - Payments made via Klarna \* \`alipay_hk\` - Payments made via Alipay HK \* \`paypay\` - Payments made via PayPay \* \`gcash\` - Payments made via GCash \* \`south_korean_cards\` - Payments made via South Korean Cards \* \`paynow\` - Payments made via PayNow \* \`bizum\` - Payments made via Bizum \* \`promptpay\` - Payments made via PromptPay enum: - card - paypal_express_checkout @@ -31735,11 +31808,14 @@ paths: - paypay - gcash - south_korean_cards + - paynow + - bizum + - promptpay example: null is_not: type: string description: | - \* \`card\` - Card based payment including credit cards and debit cards. Details about the card can be obtained from the card resource. \* \`paypal_express_checkout\` - Payments made via PayPal Express Checkout. \* \`amazon_payments\` - Payments made via Amazon Payments. \* \`direct_debit\` - Represents bank account for which the direct debit or ACH agreement/mandate is created. \* \`generic\` - Payments made via Generic Payment Method. \* \`alipay\` - Payments made via Alipay \* \`unionpay\` - Payments made via UnionPay. \* \`apple_pay\` - Payments made via Apple Pay. \* \`wechat_pay\` - Payments made via WeChat Pay \* \`ideal\` - Payments made via iDEAL. \* \`google_pay\` - Payments made via Google Pay. \* \`sofort\` - Payments made via Sofort. \* \`bancontact\` - Payments made via Bancontact Card. \* \`giropay\` - Payments made via giropay. \* \`dotpay\` - Payments made via Dotpay. \* \`upi\` - UPI Payments. \* \`netbanking_emandates\` - Netbanking (eMandates) Payments. \* \`venmo\` - Payments made via Venmo \* \`pay_to\` - Payments made via PayTo \* \`faster_payments\` - Payments made via Faster Payments \* \`sepa_instant_transfer\` - Payments made via Sepa Instant Transfer \* \`automated_bank_transfer\` - Represents virtual bank account using which the payment will be done. \* \`klarna_pay_now\` - Payments made via Klarna Pay Now \* \`online_banking_poland\` - Payments made via Online Banking Poland \* \`payconiq_by_bancontact\` - Payments made via Payconiq by Bancontact \* \`electronic_payment_standard\` - Payments made via Electronic Payment Standard. \* \`kbc_payment_button\` - Payments made via KBC Payment Button. \* \`pay_by_bank\` - Payments made via Pay By Bank. \* \`trustly\` - Payments made via Trustly. \* \`stablecoin\` - Payments made via Stablecoin \* \`kakao_pay\` - Payments made via Kakao Pay \* \`naver_pay\` - Payments made via Naver Pay \* \`revolut_pay\` - Payments made via Revolut Pay \* \`cash_app_pay\` - Payments made via Cash App Pay \* \`twint\` - Payments made via Twint \* \`go_pay\` - Payments made via Go Pay \* \`grab_pay\` - Payments made via Grab Pay \* \`pay_co\` - Payments made via Pay Co \* \`after_pay\` - Payments made via After pay \* \`swish\` - Payments made via Swish \* \`payme\` - Payments made via PayMe \* \`pix\` - Payments made via Pix \* \`klarna\` - Payments made via Klarna \* \`alipay_hk\` - Payments made via Alipay HK \* \`paypay\` - Payments made via PayPay \* \`gcash\` - Payments made via GCash \* \`south_korean_cards\` - Payments made via South Korean Cards + \* \`card\` - Card based payment including credit cards and debit cards. Details about the card can be obtained from the card resource. \* \`paypal_express_checkout\` - Payments made via PayPal Express Checkout. \* \`amazon_payments\` - Payments made via Amazon Payments. \* \`direct_debit\` - Represents bank account for which the direct debit or ACH agreement/mandate is created. \* \`generic\` - Payments made via Generic Payment Method. \* \`alipay\` - Payments made via Alipay \* \`unionpay\` - Payments made via UnionPay. \* \`apple_pay\` - Payments made via Apple Pay. \* \`wechat_pay\` - Payments made via WeChat Pay \* \`ideal\` - Payments made via iDEAL. \* \`google_pay\` - Payments made via Google Pay. \* \`sofort\` - Payments made via Sofort. \* \`bancontact\` - Payments made via Bancontact Card. \* \`giropay\` - Payments made via giropay. \* \`dotpay\` - Payments made via Dotpay. \* \`upi\` - UPI Payments. \* \`netbanking_emandates\` - Netbanking (eMandates) Payments. \* \`venmo\` - Payments made via Venmo \* \`pay_to\` - Payments made via PayTo \* \`faster_payments\` - Payments made via Faster Payments \* \`sepa_instant_transfer\` - Payments made via Sepa Instant Transfer \* \`automated_bank_transfer\` - Represents virtual bank account using which the payment will be done. \* \`klarna_pay_now\` - Payments made via Klarna Pay Now \* \`online_banking_poland\` - Payments made via Online Banking Poland \* \`payconiq_by_bancontact\` - Payments made via Payconiq by Bancontact \* \`electronic_payment_standard\` - Payments made via Electronic Payment Standard. \* \`kbc_payment_button\` - Payments made via KBC Payment Button. \* \`pay_by_bank\` - Payments made via Pay By Bank. \* \`trustly\` - Payments made via Trustly. \* \`stablecoin\` - Payments made via Stablecoin \* \`kakao_pay\` - Payments made via Kakao Pay \* \`naver_pay\` - Payments made via Naver Pay \* \`revolut_pay\` - Payments made via Revolut Pay \* \`cash_app_pay\` - Payments made via Cash App Pay \* \`twint\` - Payments made via Twint \* \`go_pay\` - Payments made via Go Pay \* \`grab_pay\` - Payments made via Grab Pay \* \`pay_co\` - Payments made via Pay Co \* \`after_pay\` - Payments made via After pay \* \`swish\` - Payments made via Swish \* \`payme\` - Payments made via PayMe \* \`pix\` - Payments made via Pix \* \`klarna\` - Payments made via Klarna \* \`alipay_hk\` - Payments made via Alipay HK \* \`paypay\` - Payments made via PayPay \* \`gcash\` - Payments made via GCash \* \`south_korean_cards\` - Payments made via South Korean Cards \* \`paynow\` - Payments made via PayNow \* \`bizum\` - Payments made via Bizum \* \`promptpay\` - Payments made via PromptPay enum: - card - paypal_express_checkout @@ -31788,11 +31864,14 @@ paths: - paypay - gcash - south_korean_cards + - paynow + - bizum + - promptpay example: null in: type: string description: | - \* \`card\` - Card based payment including credit cards and debit cards. Details about the card can be obtained from the card resource. \* \`paypal_express_checkout\` - Payments made via PayPal Express Checkout. \* \`amazon_payments\` - Payments made via Amazon Payments. \* \`direct_debit\` - Represents bank account for which the direct debit or ACH agreement/mandate is created. \* \`generic\` - Payments made via Generic Payment Method. \* \`alipay\` - Payments made via Alipay \* \`unionpay\` - Payments made via UnionPay. \* \`apple_pay\` - Payments made via Apple Pay. \* \`wechat_pay\` - Payments made via WeChat Pay \* \`ideal\` - Payments made via iDEAL. \* \`google_pay\` - Payments made via Google Pay. \* \`sofort\` - Payments made via Sofort. \* \`bancontact\` - Payments made via Bancontact Card. \* \`giropay\` - Payments made via giropay. \* \`dotpay\` - Payments made via Dotpay. \* \`upi\` - UPI Payments. \* \`netbanking_emandates\` - Netbanking (eMandates) Payments. \* \`venmo\` - Payments made via Venmo \* \`pay_to\` - Payments made via PayTo \* \`faster_payments\` - Payments made via Faster Payments \* \`sepa_instant_transfer\` - Payments made via Sepa Instant Transfer \* \`automated_bank_transfer\` - Represents virtual bank account using which the payment will be done. \* \`klarna_pay_now\` - Payments made via Klarna Pay Now \* \`online_banking_poland\` - Payments made via Online Banking Poland \* \`payconiq_by_bancontact\` - Payments made via Payconiq by Bancontact \* \`electronic_payment_standard\` - Payments made via Electronic Payment Standard. \* \`kbc_payment_button\` - Payments made via KBC Payment Button. \* \`pay_by_bank\` - Payments made via Pay By Bank. \* \`trustly\` - Payments made via Trustly. \* \`stablecoin\` - Payments made via Stablecoin \* \`kakao_pay\` - Payments made via Kakao Pay \* \`naver_pay\` - Payments made via Naver Pay \* \`revolut_pay\` - Payments made via Revolut Pay \* \`cash_app_pay\` - Payments made via Cash App Pay \* \`twint\` - Payments made via Twint \* \`go_pay\` - Payments made via Go Pay \* \`grab_pay\` - Payments made via Grab Pay \* \`pay_co\` - Payments made via Pay Co \* \`after_pay\` - Payments made via After pay \* \`swish\` - Payments made via Swish \* \`payme\` - Payments made via PayMe \* \`pix\` - Payments made via Pix \* \`klarna\` - Payments made via Klarna \* \`alipay_hk\` - Payments made via Alipay HK \* \`paypay\` - Payments made via PayPay \* \`gcash\` - Payments made via GCash \* \`south_korean_cards\` - Payments made via South Korean Cards + \* \`card\` - Card based payment including credit cards and debit cards. Details about the card can be obtained from the card resource. \* \`paypal_express_checkout\` - Payments made via PayPal Express Checkout. \* \`amazon_payments\` - Payments made via Amazon Payments. \* \`direct_debit\` - Represents bank account for which the direct debit or ACH agreement/mandate is created. \* \`generic\` - Payments made via Generic Payment Method. \* \`alipay\` - Payments made via Alipay \* \`unionpay\` - Payments made via UnionPay. \* \`apple_pay\` - Payments made via Apple Pay. \* \`wechat_pay\` - Payments made via WeChat Pay \* \`ideal\` - Payments made via iDEAL. \* \`google_pay\` - Payments made via Google Pay. \* \`sofort\` - Payments made via Sofort. \* \`bancontact\` - Payments made via Bancontact Card. \* \`giropay\` - Payments made via giropay. \* \`dotpay\` - Payments made via Dotpay. \* \`upi\` - UPI Payments. \* \`netbanking_emandates\` - Netbanking (eMandates) Payments. \* \`venmo\` - Payments made via Venmo \* \`pay_to\` - Payments made via PayTo \* \`faster_payments\` - Payments made via Faster Payments \* \`sepa_instant_transfer\` - Payments made via Sepa Instant Transfer \* \`automated_bank_transfer\` - Represents virtual bank account using which the payment will be done. \* \`klarna_pay_now\` - Payments made via Klarna Pay Now \* \`online_banking_poland\` - Payments made via Online Banking Poland \* \`payconiq_by_bancontact\` - Payments made via Payconiq by Bancontact \* \`electronic_payment_standard\` - Payments made via Electronic Payment Standard. \* \`kbc_payment_button\` - Payments made via KBC Payment Button. \* \`pay_by_bank\` - Payments made via Pay By Bank. \* \`trustly\` - Payments made via Trustly. \* \`stablecoin\` - Payments made via Stablecoin \* \`kakao_pay\` - Payments made via Kakao Pay \* \`naver_pay\` - Payments made via Naver Pay \* \`revolut_pay\` - Payments made via Revolut Pay \* \`cash_app_pay\` - Payments made via Cash App Pay \* \`twint\` - Payments made via Twint \* \`go_pay\` - Payments made via Go Pay \* \`grab_pay\` - Payments made via Grab Pay \* \`pay_co\` - Payments made via Pay Co \* \`after_pay\` - Payments made via After pay \* \`swish\` - Payments made via Swish \* \`payme\` - Payments made via PayMe \* \`pix\` - Payments made via Pix \* \`klarna\` - Payments made via Klarna \* \`alipay_hk\` - Payments made via Alipay HK \* \`paypay\` - Payments made via PayPay \* \`gcash\` - Payments made via GCash \* \`south_korean_cards\` - Payments made via South Korean Cards \* \`paynow\` - Payments made via PayNow \* \`bizum\` - Payments made via Bizum \* \`promptpay\` - Payments made via PromptPay enum: - card - paypal_express_checkout @@ -31841,13 +31920,16 @@ paths: - paypay - gcash - south_korean_cards - pattern: "^\\[(card|paypal_express_checkout|amazon_payments|direct_debit|generic|alipay|unionpay|apple_pay|wechat_pay|ideal|google_pay|sofort|bancontact|giropay|dotpay|upi|netbanking_emandates|venmo|pay_to|faster_payments|sepa_instant_transfer|automated_bank_transfer|klarna_pay_now|online_banking_poland|payconiq_by_bancontact|electronic_payment_standard|kbc_payment_button|pay_by_bank|trustly|stablecoin|kakao_pay|naver_pay|revolut_pay|cash_app_pay|twint|go_pay|grab_pay|pay_co|after_pay|swish|payme|pix|klarna|alipay_hk|paypay|gcash|south_korean_cards)(,(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 + pattern: "^\\[(card|paypal_express_checkout|amazon_payments|direct_debit|generic|alipay|unionpay|apple_pay|wechat_pay|ideal|google_pay|sofort|bancontact|giropay|dotpay|upi|netbanking_emandates|venmo|pay_to|faster_payments|sepa_instant_transfer|automated_bank_transfer|klarna_pay_now|online_banking_poland|payconiq_by_bancontact|electronic_payment_standard|kbc_payment_button|pay_by_bank|trustly|stablecoin|kakao_pay|naver_pay|revolut_pay|cash_app_pay|twint|go_pay|grab_pay|pay_co|after_pay|swish|payme|pix|klarna|alipay_hk|paypay|gcash|south_korean_cards|paynow|bizum|promptpay)(,(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))*\\\ ]$" example: null not_in: type: string description: | - \* \`card\` - Card based payment including credit cards and debit cards. Details about the card can be obtained from the card resource. \* \`paypal_express_checkout\` - Payments made via PayPal Express Checkout. \* \`amazon_payments\` - Payments made via Amazon Payments. \* \`direct_debit\` - Represents bank account for which the direct debit or ACH agreement/mandate is created. \* \`generic\` - Payments made via Generic Payment Method. \* \`alipay\` - Payments made via Alipay \* \`unionpay\` - Payments made via UnionPay. \* \`apple_pay\` - Payments made via Apple Pay. \* \`wechat_pay\` - Payments made via WeChat Pay \* \`ideal\` - Payments made via iDEAL. \* \`google_pay\` - Payments made via Google Pay. \* \`sofort\` - Payments made via Sofort. \* \`bancontact\` - Payments made via Bancontact Card. \* \`giropay\` - Payments made via giropay. \* \`dotpay\` - Payments made via Dotpay. \* \`upi\` - UPI Payments. \* \`netbanking_emandates\` - Netbanking (eMandates) Payments. \* \`venmo\` - Payments made via Venmo \* \`pay_to\` - Payments made via PayTo \* \`faster_payments\` - Payments made via Faster Payments \* \`sepa_instant_transfer\` - Payments made via Sepa Instant Transfer \* \`automated_bank_transfer\` - Represents virtual bank account using which the payment will be done. \* \`klarna_pay_now\` - Payments made via Klarna Pay Now \* \`online_banking_poland\` - Payments made via Online Banking Poland \* \`payconiq_by_bancontact\` - Payments made via Payconiq by Bancontact \* \`electronic_payment_standard\` - Payments made via Electronic Payment Standard. \* \`kbc_payment_button\` - Payments made via KBC Payment Button. \* \`pay_by_bank\` - Payments made via Pay By Bank. \* \`trustly\` - Payments made via Trustly. \* \`stablecoin\` - Payments made via Stablecoin \* \`kakao_pay\` - Payments made via Kakao Pay \* \`naver_pay\` - Payments made via Naver Pay \* \`revolut_pay\` - Payments made via Revolut Pay \* \`cash_app_pay\` - Payments made via Cash App Pay \* \`twint\` - Payments made via Twint \* \`go_pay\` - Payments made via Go Pay \* \`grab_pay\` - Payments made via Grab Pay \* \`pay_co\` - Payments made via Pay Co \* \`after_pay\` - Payments made via After pay \* \`swish\` - Payments made via Swish \* \`payme\` - Payments made via PayMe \* \`pix\` - Payments made via Pix \* \`klarna\` - Payments made via Klarna \* \`alipay_hk\` - Payments made via Alipay HK \* \`paypay\` - Payments made via PayPay \* \`gcash\` - Payments made via GCash \* \`south_korean_cards\` - Payments made via South Korean Cards + \* \`card\` - Card based payment including credit cards and debit cards. Details about the card can be obtained from the card resource. \* \`paypal_express_checkout\` - Payments made via PayPal Express Checkout. \* \`amazon_payments\` - Payments made via Amazon Payments. \* \`direct_debit\` - Represents bank account for which the direct debit or ACH agreement/mandate is created. \* \`generic\` - Payments made via Generic Payment Method. \* \`alipay\` - Payments made via Alipay \* \`unionpay\` - Payments made via UnionPay. \* \`apple_pay\` - Payments made via Apple Pay. \* \`wechat_pay\` - Payments made via WeChat Pay \* \`ideal\` - Payments made via iDEAL. \* \`google_pay\` - Payments made via Google Pay. \* \`sofort\` - Payments made via Sofort. \* \`bancontact\` - Payments made via Bancontact Card. \* \`giropay\` - Payments made via giropay. \* \`dotpay\` - Payments made via Dotpay. \* \`upi\` - UPI Payments. \* \`netbanking_emandates\` - Netbanking (eMandates) Payments. \* \`venmo\` - Payments made via Venmo \* \`pay_to\` - Payments made via PayTo \* \`faster_payments\` - Payments made via Faster Payments \* \`sepa_instant_transfer\` - Payments made via Sepa Instant Transfer \* \`automated_bank_transfer\` - Represents virtual bank account using which the payment will be done. \* \`klarna_pay_now\` - Payments made via Klarna Pay Now \* \`online_banking_poland\` - Payments made via Online Banking Poland \* \`payconiq_by_bancontact\` - Payments made via Payconiq by Bancontact \* \`electronic_payment_standard\` - Payments made via Electronic Payment Standard. \* \`kbc_payment_button\` - Payments made via KBC Payment Button. \* \`pay_by_bank\` - Payments made via Pay By Bank. \* \`trustly\` - Payments made via Trustly. \* \`stablecoin\` - Payments made via Stablecoin \* \`kakao_pay\` - Payments made via Kakao Pay \* \`naver_pay\` - Payments made via Naver Pay \* \`revolut_pay\` - Payments made via Revolut Pay \* \`cash_app_pay\` - Payments made via Cash App Pay \* \`twint\` - Payments made via Twint \* \`go_pay\` - Payments made via Go Pay \* \`grab_pay\` - Payments made via Grab Pay \* \`pay_co\` - Payments made via Pay Co \* \`after_pay\` - Payments made via After pay \* \`swish\` - Payments made via Swish \* \`payme\` - Payments made via PayMe \* \`pix\` - Payments made via Pix \* \`klarna\` - Payments made via Klarna \* \`alipay_hk\` - Payments made via Alipay HK \* \`paypay\` - Payments made via PayPay \* \`gcash\` - Payments made via GCash \* \`south_korean_cards\` - Payments made via South Korean Cards \* \`paynow\` - Payments made via PayNow \* \`bizum\` - Payments made via Bizum \* \`promptpay\` - Payments made via PromptPay enum: - card - paypal_express_checkout @@ -31896,7 +31978,10 @@ paths: - paypay - gcash - south_korean_cards - pattern: "^\\[(card|paypal_express_checkout|amazon_payments|direct_debit|generic|alipay|unionpay|apple_pay|wechat_pay|ideal|google_pay|sofort|bancontact|giropay|dotpay|upi|netbanking_emandates|venmo|pay_to|faster_payments|sepa_instant_transfer|automated_bank_transfer|klarna_pay_now|online_banking_poland|payconiq_by_bancontact|electronic_payment_standard|kbc_payment_button|pay_by_bank|trustly|stablecoin|kakao_pay|naver_pay|revolut_pay|cash_app_pay|twint|go_pay|grab_pay|pay_co|after_pay|swish|payme|pix|klarna|alipay_hk|paypay|gcash|south_korean_cards)(,(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 + pattern: "^\\[(card|paypal_express_checkout|amazon_payments|direct_debit|generic|alipay|unionpay|apple_pay|wechat_pay|ideal|google_pay|sofort|bancontact|giropay|dotpay|upi|netbanking_emandates|venmo|pay_to|faster_payments|sepa_instant_transfer|automated_bank_transfer|klarna_pay_now|online_banking_poland|payconiq_by_bancontact|electronic_payment_standard|kbc_payment_button|pay_by_bank|trustly|stablecoin|kakao_pay|naver_pay|revolut_pay|cash_app_pay|twint|go_pay|grab_pay|pay_co|after_pay|swish|payme|pix|klarna|alipay_hk|paypay|gcash|south_korean_cards|paynow|bizum|promptpay)(,(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))*\\\ ]$" example: null - name: status @@ -32749,6 +32834,9 @@ paths: - paypay - gcash - south_korean_cards + - paynow + - bizum + - promptpay example: null reference_id: type: string @@ -33612,6 +33700,9 @@ paths: - paypay - gcash - south_korean_cards + - paynow + - bizum + - promptpay example: null tmp_token: type: string @@ -38716,7 +38807,7 @@ paths: - BasicAuth: [] /promotional_credits/deduct: post: - summary: Deduct Promotional Credits + summary: Deduct promotional credits description: | This API call can be used to deduct promotional credits for a customer. [Learn more about Promotional Credits](https://www.chargebee.com/docs/2.0/credit-notes.html#creating-promotional-credits). @@ -38997,7 +39088,7 @@ paths: - BasicAuth: [] /promotional_credits/set: post: - summary: Set Promotional Credits + summary: Set promotional credits description: | This API call can be used to set the promotional credits balance of a customer. [Learn more about Promotional Credits](https://www.chargebee.com/docs/2.0/credit-notes.html#creating-promotional-credits). @@ -39271,7 +39362,7 @@ paths: - BasicAuth: [] /promotional_credits/add: post: - summary: Add Promotional Credits + summary: Add promotional credits description: | This API call can be used to add promotional credits to a customer. [Learn more about Promotional Credits](https://www.chargebee.com/docs/2.0/credit-notes.html#creating-promotional-credits). @@ -39541,7 +39632,7 @@ paths: - BasicAuth: [] /invoices/{invoice-id}/delete_line_items: post: - summary: Delete Line Items + summary: Delete line items description: | This endpoint is used to delete line items from "Pending" invoice. operationId: delete_line_items @@ -45041,6 +45132,9 @@ paths: - paypay - gcash - south_korean_cards + - paynow + - bizum + - promptpay example: null gateway_account_id: type: string @@ -45352,6 +45446,9 @@ paths: - paypay - gcash - south_korean_cards + - paynow + - bizum + - promptpay example: null reference_id: type: string @@ -48383,6 +48480,9 @@ paths: deprecated: false description: | The reason for exempting the invoice from tax. (Applicable only for exempted invoices.). + \* zero_rated - + + If the rate of tax is 0% and no Sales/ GST tax is collectable for that line item \* export - The customer is from a non-taxable region or the billing address and shipping address are unavailable. @@ -48390,15 +48490,36 @@ paths: The customer is [exempted](/docs/api/customers/customer-object#taxability) from tax. + \* tax_not_configured_external_provider - + + If the tax is not configured for the country in 3rd party tax provider. \* id_exempt - The customer is from a different country than your business and they have a valid VAT number or, the customer is a business entity. (This reason is only applicable when [EU VAT](https://www.chargebee.com/docs/eu-vat.html) or [UK VAT](https://www.chargebee.com/docs/uk-vat.html) is enabled.) + \* high_value_physical_goods - + + If physical goods are sold from outside Australia to customers in Australia, and the price of all the physical good line items is greater than AUD 1000, then tax will not be applied + \* product_exempt - + + If the Plan or Addon is marked as Tax exempt + \* region_non_taxable - + + If the product sold is not taxable in this region, but it is taxable in other regions, hence this region is not part of the Taxable jurisdiction + \* zero_value_item - + + If the total invoice value/amount is equal to zero. E.g., If the total order value is $10 and a $10 coupon has been applied against that order, the total order value becomes $0. Hence the invoice value also becomes $0. enum: + - zero_rated - id_exempt - customer_exempt + - region_non_taxable + - product_exempt - export + - high_value_physical_goods + - zero_value_item + - tax_not_configured_external_provider example: null vat_number: type: string @@ -48545,6 +48666,17 @@ paths: description: | If the invoice falls within the subscription current term will be used for proration. example: null + paid_at: + type: integer + format: unix-time + deprecated: false + description:

Timestamp when the invoice was paid. + Applicable only when status is paid.

+ example: null credit_note: type: object deprecated: false @@ -49253,6 +49385,20 @@ paths: minimum: 0 example: null example: null + proration_mode: + type: array + items: + type: string + deprecated: false + description: | + Proration mode for the line item. + enum: + - reset + - delta + - service_period_revision + - adjusted_term + example: null + example: null created_at: type: array description: "" @@ -51175,14 +51321,14 @@ paths: deprecated: false example: old_inv_001 properties: - is: - type: string - minLength: 1 - example: null in: type: string pattern: "^\\[(.*)(,.*)*\\]$" example: null + is: + type: string + minLength: 1 + example: null - name: payment_reference_number in: query description: | @@ -51202,14 +51348,14 @@ paths: This parameter is used to identify the PRN in the system and retrieve its corresponding payment information. \*\*Note\*\*: To retrieve the PRN, the API requires either the invoice ID or the payment reference number to be provided by the user. If both values are missing, an error will be returned by the API. example: "001234" properties: - is: - type: string - minLength: 1 - example: null in: type: string pattern: "^\\[(.*)(,.*)*\\]$" example: null + is: + type: string + minLength: 1 + example: null example: null responses: "200": @@ -52465,7 +52611,7 @@ paths: - BasicAuth: [] /invoices/{invoice-id}/pdf: post: - summary: Retrieve Invoice as PDF + 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. @@ -53920,6 +54066,20 @@ paths: minimum: 0 example: null example: null + proration_mode: + type: array + items: + type: string + deprecated: false + description: | + Proration mode for the line item. + enum: + - reset + - delta + - service_period_revision + - adjusted_term + example: null + example: null required: - description example: null @@ -54476,7 +54636,7 @@ paths: - BasicAuth: [] /credit_notes/{credit-note-id}/delete: post: - summary: Delete a credit Note + summary: Delete a credit note description: | This API [deletes a credit note.](https://www.chargebee.com/docs/credit-notes.html#voiding-or-deleting-a-credit-note) A credit note once deleted, is deleted permanently. You cannot delete a credit which has already been deleted or refunded. If you try to delete a refunded or deleted credit note, an error message will be displayed. operationId: delete_a_credit_note @@ -65360,6 +65520,9 @@ paths: - paypay - gcash - south_korean_cards + - paynow + - bizum + - promptpay example: null reference_id: type: string @@ -66147,8 +66310,22 @@ paths: /transactions: get: summary: List transactions - description: | - Lists all the 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.

" operationId: list_transactions parameters: - name: chargebee-request-origin-device @@ -66522,6 +66699,9 @@ paths: * `paypay` - PayPay * `gcash` - GCash * `south_korean_cards` - Payments made via South Korean Cards + * `paynow` - Payments made via PayNow + * `bizum` - Payments made via Bizum + * `promptpay` - Payments made via PromptPay enum: - card - cash @@ -66578,6 +66758,9 @@ paths: - paypay - gcash - south_korean_cards + - paynow + - bizum + - promptpay example: null is_not: type: string @@ -66639,6 +66822,9 @@ paths: * `paypay` - PayPay * `gcash` - GCash * `south_korean_cards` - Payments made via South Korean Cards + * `paynow` - Payments made via PayNow + * `bizum` - Payments made via Bizum + * `promptpay` - Payments made via PromptPay enum: - card - cash @@ -66695,6 +66881,9 @@ paths: - paypay - gcash - south_korean_cards + - paynow + - bizum + - promptpay example: null in: type: string @@ -66756,6 +66945,9 @@ paths: * `paypay` - PayPay * `gcash` - GCash * `south_korean_cards` - Payments made via South Korean Cards + * `paynow` - Payments made via PayNow + * `bizum` - Payments made via Bizum + * `promptpay` - Payments made via PromptPay enum: - card - cash @@ -66812,7 +67004,10 @@ paths: - paypay - gcash - south_korean_cards - 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)(,(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 + 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)(,(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))*\\\ ]$" example: null not_in: @@ -66875,6 +67070,9 @@ paths: * `paypay` - PayPay * `gcash` - GCash * `south_korean_cards` - Payments made via South Korean Cards + * `paynow` - Payments made via PayNow + * `bizum` - Payments made via Bizum + * `promptpay` - Payments made via PromptPay enum: - card - cash @@ -66931,7 +67129,10 @@ paths: - paypay - gcash - south_korean_cards - 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)(,(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 + 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)(,(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))*\\\ ]$" example: null - name: gateway @@ -67657,15 +67858,16 @@ paths: example: null - name: date in: query - description: | - optional, timestamp(UTC) in seconds filter - - Indicates when this transaction occurred. - **Supported operators :** - after, before, on, between - - **Example →** - *date\[before\] = "1435054328"* + description: |- +

optional, timestamp(UTC) in seconds filter

 +

Indicates when this transaction occurred. + We recommend using this filter when listing transactions for better query performance. It is advisable when using this filter, to pass the sort_by + input parameter as date + for a faster response. + Supported operators : + after, before, on, between

+

Example → + date[before] = "1435054328"

required: false deprecated: false style: deepObject @@ -69893,7 +70095,7 @@ paths: - BasicAuth: [] /hosted_pages/extend_subscription: post: - summary: Extend Subscription + 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: